t

endpoints

# PartialInvariantFunctor

#### traitPartialInvariantFunctor[F[_]] extends InvariantFunctor[F]

Given a type constructor `F`, a partial function `A => Validated[B]` and a total function `B => A`, turns an `F[A]` into an `F[B]`.

A partial invariant functor is an invariant functor whose covariant transformation function is total (ie, `A => Valid[B]`).

Source
InvariantFunctor.scala
Linear Supertypes
Type Hierarchy
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. PartialInvariantFunctor
2. InvariantFunctor
3. AnyRef
4. Any
Implicitly
1. by StringFormat
2. by Ensuring
3. by ArrowAssoc
1. Hide All
2. Show All
Visibility
1. Public
2. Protected

### Abstract Value Members

1. abstract def xmapPartial[A, B](fa: F[A], f: (A) => Validated[B], g: (B) => A): F[B]

Transforms an `F[A]` value into an `F[B]` value given a partial function from `A` to `B`, and a total function from `B` to `A`.

Transforms an `F[A]` value into an `F[B]` value given a partial function from `A` to `B`, and a total function from `B` to `A`.

This is useful to refine the type `A` into a possibly smaller type `B`.

Some examples

### Concrete Value Members

1. final def !=(arg0: Any)
Definition Classes
AnyRef → Any
2. final def ##(): Int
Definition Classes
AnyRef → Any
3. def ->[B](y: B): (PartialInvariantFunctor[F], B)
Implicit
This member is added by an implicit conversion from PartialInvariantFunctor[F] toArrowAssoc[PartialInvariantFunctor[F]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
4. final def ==(arg0: Any)
Definition Classes
AnyRef → Any
5. final def asInstanceOf[T0]: T0
Definition Classes
Any
6. def clone()
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
7. def ensuring(cond: (PartialInvariantFunctor[F]) => Boolean, msg: => Any)
Implicit
This member is added by an implicit conversion from PartialInvariantFunctor[F] toEnsuring[PartialInvariantFunctor[F]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
8. def ensuring(cond: (PartialInvariantFunctor[F]) => Boolean)
Implicit
This member is added by an implicit conversion from PartialInvariantFunctor[F] toEnsuring[PartialInvariantFunctor[F]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
9. def ensuring(cond: Boolean, msg: => Any)
Implicit
This member is added by an implicit conversion from PartialInvariantFunctor[F] toEnsuring[PartialInvariantFunctor[F]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
10. def ensuring(cond: Boolean)
Implicit
This member is added by an implicit conversion from PartialInvariantFunctor[F] toEnsuring[PartialInvariantFunctor[F]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
11. final def eq(arg0: AnyRef)
Definition Classes
AnyRef
12. def equals(arg0: AnyRef)
Definition Classes
AnyRef → Any
13. def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
14. def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from PartialInvariantFunctor[F] toStringFormat[PartialInvariantFunctor[F]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
15. final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
16. def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
17. final def isInstanceOf[T0]
Definition Classes
Any
18. final def ne(arg0: AnyRef)
Definition Classes
AnyRef
19. final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
20. final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
21. final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
22. def toString(): String
Definition Classes
AnyRef → Any
23. final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
24. final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
25. final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
26. def xmap[A, B](fa: F[A], f: (A) => B, g: (B) => A): F[B]

Transforms an `F[A]` value into an `F[B]` value given a pair of functions from `A` to `B` and from `B` to `A`.

Transforms an `F[A]` value into an `F[B]` value given a pair of functions from `A` to `B` and from `B` to `A`.

Definition Classes
PartialInvariantFunctorInvariantFunctor

Some examples

### Deprecated Value Members

1. def [B](y: B): (PartialInvariantFunctor[F], B)
Implicit
This member is added by an implicit conversion from PartialInvariantFunctor[F] toArrowAssoc[PartialInvariantFunctor[F]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated

(Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.