abstract class InjectK[F[_], G[_]] extends AnyRef

InjectK is a type class providing an injection from type constructor F into type constructor G. An injection is a functor transformation inj which does not destroy any information: for every ga: G[A] there is at most one fa: F[A] such that inj(fa) = ga.

Because of this all injections admit partial inverses prj which pair a value ga: G[A] back with a single value fa: F[A].

The behavior of the default instances for the InjectK type class are described thoroughly in "Data types a la carte" (Swierstra 2008).

Source
InjectK.scala
Note

Prior to cats 1.0, InjectK was known as Inject.

See also

http://www.staff.science.uu.nl/~swier004/publications/2008-jfp.pdf

Inject for injection for Either

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InjectK
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InjectK()

Abstract Value Members

  1. abstract def inj: FunctionK[F, G]
  2. abstract def prj: FunctionK[G, [α]Option[F[α]]]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def apply[A](fa: F[A]): G[A]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def unapply[A](ga: G[A]): Option[F[A]]
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped