Packages

final case class EitherK[F[_], G[_], A](run: Either[F[A], G[A]]) extends Product with Serializable

F on the left and G on the right of scala.util.Either.

run

The underlying scala.util.Either.

Source
EitherK.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EitherK
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EitherK(run: Either[F[A], G[A]])

    run

    The underlying scala.util.Either.

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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. def coflatMap[B](f: (EitherK[F, G, A]) ⇒ B)(implicit F: CoflatMap[F], G: CoflatMap[G]): EitherK[F, G, B]
  7. def coflatten(implicit F: CoflatMap[F], G: CoflatMap[G]): EitherK[F, G, EitherK[F, G, A]]
  8. def contramap[B](f: (B) ⇒ A)(implicit F: Contravariant[F], G: Contravariant[G]): EitherK[F, G, B]
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def extract(implicit F: Comonad[F], G: Comonad[G]): A
  11. def fold[H[_]](f: FunctionK[F, H], g: FunctionK[G, H]): H[A]

    Fold this eitherK into a new type constructor using two natural transformations.

    Fold this eitherK into a new type constructor using two natural transformations.

    Example:

    scala> import cats.arrow.FunctionK
    scala> import cats.data.EitherK
    scala> val listToOption = λ[FunctionK[List, Option]](_.headOption)
    scala> val optionToOption = FunctionK.id[Option]
    scala> val cp1: EitherK[List, Option, Int] = EitherK.leftc(List(1,2,3))
    scala> val cp2: EitherK[List, Option, Int] = EitherK.rightc(Some(4))
    scala> cp1.fold(listToOption, optionToOption)
    res0: Option[Int] = Some(1)
    scala> cp2.fold(listToOption, optionToOption)
    res1: Option[Int] = Some(4)
  12. def foldLeft[B](z: B)(f: (B, A) ⇒ B)(implicit F: Foldable[F], G: Foldable[G]): B
  13. def foldMap[B](f: (A) ⇒ B)(implicit F: Foldable[F], G: Foldable[G], M: Monoid[B]): B
  14. def foldRight[B](z: Eval[B])(f: (A, Eval[B]) ⇒ Eval[B])(implicit F: Foldable[F], G: Foldable[G]): Eval[B]
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isLeft: Boolean
  18. def isRight: Boolean
  19. def map[B](f: (A) ⇒ B)(implicit F: Functor[F], G: Functor[G]): EitherK[F, G, B]
  20. def mapK[H[_]](f: ~>[G, H]): EitherK[F, H, A]

    Modify the right side context G using transformation f.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. val run: Either[F[A], G[A]]
  25. def swap: EitherK[G, F, A]
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toValidated: Validated[F[A], G[A]]
  28. def traverse[X[_], B](g: (A) ⇒ X[B])(implicit F: Traverse[F], G: Traverse[G], A: Applicative[X]): X[EitherK[F, G, B]]
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped