Packages

trait Covariant[F[+_]] extends CovariantSubset[F, AnyType] with Invariant[F]

Covariant[F] provides implicit evidence that F[+_] is a covariant endofunctor in the category of Scala objects.

Covariant instances of type F[A] "produce" values of type A in some sense. In some cases, such as with a List[A], this means that they contain values of type A, in which case we can simply access the elements of the collection. In other cases it means that output values of type A which may not already exists, such as with a Function0[A] that produces A values when invoked.

Common examples of covariant instances in ZIO includes effects with respect to their error and value types, sinks with respect to their error and output types, and queues and references with respect to their error and output types.

Covariant instances support a map operation which allows transforming the output type given a function from the old output type to the new output type. For example, if we have a List[String] and a function String => Int that returns the length of a string, then we can construct a List[Int] with the length of each string.

Self Type
Covariant[F]
Linear Supertypes
Invariant[F], CovariantSubset[F, AnyType], AnyRef, Any
Known Subclasses
ForEach, NonEmptyForEach, AssociativeFlattenCovariantDeriveEqual, CovariantDeriveEqual, CovariantDeriveEqualIdentityFlatten, DeriveEqualForEach, DeriveEqualNonEmptyForEach
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Covariant
  2. Invariant
  3. CovariantSubset
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def map[A, B](f: (A) => B): (F[A]) => F[B]

    Lift a function from A to B to a function from F[A] to F[B].

Concrete Value Members

  1. final def compose[G[-_]](implicit g: Contravariant[G]): Contravariant[[-A]F[G[A]]]

    Compose covariant and contravariant functors.

  2. final def compose[G[+_]](implicit g: Covariant[G]): Covariant[[+A]F[G[A]]]

    Compose two covariant functors.

  3. final def compose[G[_]](implicit g: Invariant[G]): Invariant[[A]F[G[A]]]

    Compose two invariant functors.

    Compose two invariant functors.

    Definition Classes
    Invariant
  4. def compositionLaw[A, B, C](fa: F[A], f: <=>[A, B], g: <=>[B, C])(implicit equal: Equal[F[C]]): Boolean
    Definition Classes
    Invariant
  5. def fproduct[A, B](f: (A) => B): (F[A]) => F[(A, B)]
  6. def fproductLeft[A, B](f: (A) => B): (F[A]) => F[(B, A)]
  7. def identityLaw1[A](fa: F[A])(implicit equal: Equal[F[A]]): Boolean
    Definition Classes
    Invariant
  8. final def invmap[A, B](f: <=>[A, B]): <=>[F[A], F[B]]
    Definition Classes
    Covariant → Invariant
  9. final def mapSubset[A, B](f: (A) => B)(implicit arg0: AnyType[B]): (F[A]) => F[B]
    Definition Classes
    Covariant → CovariantSubset