Class/Object

cats.data

OptionT

Related Docs: object OptionT | package data

Permalink

final case class OptionT[F[_], A](value: F[Option[A]]) extends Product with Serializable

OptionT[F[_], A] is a light wrapper on an F[Option[A]] with some convenient methods for working with this nested structure.

It may also be said that OptionT is a monad transformer for Option.

For more information, see the documentation.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionT
  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 OptionT(value: F[Option[A]])

    Permalink

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 cata[B](default: ⇒ B, f: (A) ⇒ B)(implicit F: Functor[F]): F[B]

    Permalink

    Catamorphism on the Option.

    Catamorphism on the Option. This is identical to fold, but it only has one parameter list, which can result in better type inference in some contexts.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collect[B](f: PartialFunction[A, B])(implicit F: Functor[F]): OptionT[F, B]

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

    Permalink
    Definition Classes
    AnyRef
  9. def exists(f: (A) ⇒ Boolean)(implicit F: Functor[F]): F[Boolean]

    Permalink
  10. def filter(p: (A) ⇒ Boolean)(implicit F: Functor[F]): OptionT[F, A]

    Permalink
  11. def filterNot(p: (A) ⇒ Boolean)(implicit F: Functor[F]): OptionT[F, A]

    Permalink
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def flatMap[B](f: (A) ⇒ OptionT[F, B])(implicit F: Monad[F]): OptionT[F, B]

    Permalink
  14. def flatMapF[B](f: (A) ⇒ F[Option[B]])(implicit F: Monad[F]): OptionT[F, B]

    Permalink
  15. def fold[B](default: ⇒ B)(f: (A) ⇒ B)(implicit F: Functor[F]): F[B]

    Permalink
  16. def forall(f: (A) ⇒ Boolean)(implicit F: Functor[F]): F[Boolean]

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def getOrElse(default: ⇒ A)(implicit F: Functor[F]): F[A]

    Permalink
  19. def getOrElseF(default: ⇒ F[A])(implicit F: Monad[F]): F[A]

    Permalink
  20. def isDefined(implicit F: Functor[F]): F[Boolean]

    Permalink
  21. def isEmpty(implicit F: Functor[F]): F[Boolean]

    Permalink
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def map[B](f: (A) ⇒ B)(implicit F: Functor[F]): OptionT[F, B]

    Permalink
  24. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. def orElse(default: ⇒ OptionT[F, A])(implicit F: Monad[F]): OptionT[F, A]

    Permalink
  28. def orElseF(default: ⇒ F[Option[A]])(implicit F: Monad[F]): OptionT[F, A]

    Permalink
  29. def show(implicit F: Show[F[Option[A]]]): String

    Permalink
  30. def subflatMap[B](f: (A) ⇒ Option[B])(implicit F: Functor[F]): OptionT[F, B]

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

    Permalink
    Definition Classes
    AnyRef
  32. def toLeft[R](right: ⇒ R)(implicit F: Functor[F]): XorT[F, A, R]

    Permalink
  33. def toRight[L](left: ⇒ L)(implicit F: Functor[F]): XorT[F, L, A]

    Permalink
  34. def transform[B](f: (Option[A]) ⇒ Option[B])(implicit F: Functor[F]): OptionT[F, B]

    Permalink
  35. val value: F[Option[A]]

    Permalink
  36. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def withFilter(p: (A) ⇒ Boolean)(implicit F: Functor[F]): OptionT[F, A]

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped