Trait/Object

cats.arrow

Choice

Related Docs: object Choice | package arrow

Permalink

trait Choice[F[_, _]] extends Category[F] with Serializable

Linear Supertypes
Category[F], Compose[F], Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Choice
  2. Category
  3. Compose
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def choice[A, B, C](f: F[A, C], g: F[B, C]): F[Either[A, B], C]

    Permalink

    Given two Fs (f and g) with a common target type, create a new F with the same target type, but with a source type of either f's source type OR g's source type.

    Given two Fs (f and g) with a common target type, create a new F with the same target type, but with a source type of either f's source type OR g's source type.

    Example:

    scala> import cats.implicits._
    scala> val b: Boolean => String = _ + " is a boolean"
    scala> val i: Int => String =  _ + " is an integer"
    scala> val f: (Either[Boolean, Int]) => String = b ||| i
    
    scala> f(Right(3))
    res0: String = 3 is an integer
    
    scala> f(Left(false))
    res0: String = false is a boolean
    Annotations
    @op( "|||" , true )
  2. abstract def compose[A, B, C](f: F[B, C], g: F[A, B]): F[A, C]

    Permalink
    Definition Classes
    Compose
  3. abstract def id[A]: F[A, A]

    Permalink
    Definition Classes
    Category

Concrete 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. def algebra[A]: Monoid[F[A, A]]

    Permalink
    Definition Classes
    CategoryCompose
  5. def algebraK: MonoidK[[α]F[α, α]]

    Permalink
    Definition Classes
    CategoryCompose
  6. def andThen[A, B, C](f: F[A, B], g: F[B, C]): F[A, C]

    Permalink
    Definition Classes
    Compose
  7. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def codiagonal[A]: F[Either[A, A], A]

    Permalink

    An F that, given a source A on either the right or left side, will return that same A object.

    An F that, given a source A on either the right or left side, will return that same A object.

    Example:

    scala> import cats.implicits._
    scala> val f: (Either[Int, Int]) => Int = Choice[Function1].codiagonal[Int]
    
    scala> f(Right(3))
    res0: Int = 3
    
    scala> f(Left(3))
    res1: Int = 3
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

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

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

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

Inherited from Category[F]

Inherited from Compose[F]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped