Class/Object

cats.data

EitherK

Related Docs: object EitherK | package data

Permalink

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.

Linear Supertypes
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]])

    Permalink

    run

    The underlying scala.util.Either.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def coflatMap[B](f: (EitherK[F, G, A]) ⇒ B)(implicit F: CoflatMap[F], G: CoflatMap[G]): EitherK[F, G, B]

    Permalink
  7. def coflatten(implicit F: CoflatMap[F], G: CoflatMap[G]): EitherK[F, G, EitherK[F, G, A]]

    Permalink
  8. def contramap[B](f: (B) ⇒ A)(implicit F: Contravariant[F], G: Contravariant[G]): EitherK[F, G, B]

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def extract(implicit F: Comonad[F], G: Comonad[G]): A

    Permalink
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def fold[H[_]](f: FunctionK[F, H], g: FunctionK[G, H]): H[A]

    Permalink

    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)
  13. def foldLeft[B](z: B)(f: (B, A) ⇒ B)(implicit F: Foldable[F], G: Foldable[G]): B

    Permalink
  14. def foldMap[B](f: (A) ⇒ B)(implicit F: Foldable[F], G: Foldable[G], M: Monoid[B]): B

    Permalink
  15. def foldRight[B](z: Eval[B])(f: (A, Eval[B]) ⇒ Eval[B])(implicit F: Foldable[F], G: Foldable[G]): Eval[B]

    Permalink
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def isLeft: Boolean

    Permalink
  19. def isRight: Boolean

    Permalink
  20. def map[B](f: (A) ⇒ B)(implicit F: Functor[F], G: Functor[G]): EitherK[F, G, B]

    Permalink
  21. def mapK[H[_]](f: ~>[G, H]): EitherK[F, H, A]

    Permalink

    Modify the right side context G using transformation f.

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val run: Either[F[A], G[A]]

    Permalink

    The underlying scala.util.Either.

  26. def swap: EitherK[G, F, A]

    Permalink
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toValidated: Validated[F[A], G[A]]

    Permalink
  29. def traverse[X[_], B](g: (A) ⇒ X[B])(implicit F: Traverse[F], G: Traverse[G], A: Applicative[X]): X[EitherK[F, G, B]]

    Permalink
  30. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped