Packages

  • package root
    Definition Classes
    root
  • package cats

    The cats root package contains all the trait signatures of most Scala type classes.

    The cats root package contains all the trait signatures of most Scala type classes.

    Cats type classes are implemented using the approach from the Type classes as objects and implicits article.

    For each type class, cats provides three pieces: - Its signature: a trait that is polymorphic on a type parameter. Type class traits inherit from other type classes to indicate that any implementation of the lower type class (e.g. Applicative) can also serve as an instance for the higuer type class (e.g. Functor). - Type class 'instances, which are classes and objects that implement one or more type class signatures for some specific types. Type class instances for several data types from the Java or Scala standard libraries are declared in the subpackage cats.instances. - Syntax extensions, each of which provides the methods of the type class defines as extension methods (which in Scala 2 are encoded as implicit classes) for values of any type F; given that an instance of the type class for the receiver type (this) is in the implicit scope. Symtax extensions are declared in the cats.syntax package. - A set of laws, that are also generic on the type of the class, and are only defined on the operations of the type class. The purpose of these laws is to declare some algebraic relations (equations) between Scala expressions involving the operations of the type class, and test (but not verify) that implemented instances satisfy those equations. Laws are defined in the cats-laws package.

    Although most of cats type classes are declared in this package, some are declared in other packages: - type classes that operate on base types (kind *), and their implementations for standard library types, are contained in cats.kernel, which is a different SBT project. However, they are re-exported from this package. - type classes of kind F[_, _], such as cats.arrow.Profunctor" or cats.arrow.Arrow, which are relevant for Functional Reactive Programming or optics, are declared in the cats.arrow package. - Also, those type classes that abstract over (pure or impure) functional runtime effects are declared in the cats-effect library. - Some type classes for which no laws can be provided are left out of the main road, in a small and dirty alley. These are the alleycats.

    Definition Classes
    root
  • package free
    Definition Classes
    cats
  • Cofree
  • ContravariantCoyoneda
  • Coyoneda
  • Free
  • FreeApplicative
  • FreeInvariantMonoidal
  • FreeT
  • Trampoline
  • Yoneda

object FreeT extends FreeTInstances with Serializable

Source
FreeT.scala
Linear Supertypes
Serializable, Serializable, FreeTInstances, FreeTInstances0, FreeTInstances1, FreeTInstances2, FreeTInstances3, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FreeT
  2. Serializable
  3. Serializable
  4. FreeTInstances
  5. FreeTInstances0
  6. FreeTInstances1
  7. FreeTInstances2
  8. FreeTInstances3
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. implicit def catsDeferForFreeT[S[_], M[_]](implicit arg0: Applicative[M]): Defer[[γ$11$]FreeT[S, M, γ$11$]]
    Definition Classes
    FreeTInstances
  6. implicit def catsFreeAlternativeForFreeT[S[_], M[_]](implicit arg0: Alternative[M], arg1: Monad[M]): Alternative[[γ$17$]FreeT[S, M, γ$17$]]
    Definition Classes
    FreeTInstances2
  7. implicit def catsFreeFlatMapForFreeT[S[_], M[_]](implicit M0: Applicative[M]): FlatMap[[γ$16$]FreeT[S, M, γ$16$]]
    Definition Classes
    FreeTInstances1
  8. implicit def catsFreeMonadErrorForFreeT2[S[_], M[_], E](implicit E: MonadError[M, E], S: Functor[S]): MonadError[[γ$13$]FreeT[S, M, γ$13$], E]
    Definition Classes
    FreeTInstances
  9. implicit def catsFreeMonadForFreeT[S[_], M[_]](implicit M0: Applicative[M]): Monad[[γ$15$]FreeT[S, M, γ$15$]]
    Definition Classes
    FreeTInstances0
  10. implicit def catsFreeSemigroupKForFreeT[S[_], M[_]](implicit arg0: Applicative[M], arg1: SemigroupK[M]): SemigroupK[[γ$19$]FreeT[S, M, γ$19$]]
    Definition Classes
    FreeTInstances3
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  12. def compile[S[_], T[_], M[_]](st: FunctionK[S, T])(implicit arg0: Functor[M]): FunctionK[[γ$3$]FreeT[S, M, γ$3$], [γ$4$]FreeT[T, M, γ$4$]]
  13. def defer[S[_], M[_], A](a: M[Either[A, S[FreeT[S, M, A]]]])(implicit M: Applicative[M]): FreeT[S, M, A]
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def foldMap[S[_], M[_]](fk: FunctionK[S, M])(implicit arg0: Monad[M]): FunctionK[[γ$7$]FreeT[S, M, γ$7$], M]
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def liftF[S[_], M[_], A](value: S[A])(implicit M: Applicative[M]): FreeT[S, M, A]

    Suspends a value within a functor in a single step.

    Suspends a value within a functor in a single step. Monadic unit for a higher-order monad.

  21. def liftInject[M[_], G[_]]: FreeTLiftInjectKPartiallyApplied[M, G]

    This method is used to defer the application of an InjectK[F, G] instance.

    This method is used to defer the application of an InjectK[F, G] instance. The actual work happens in FreeTLiftInjectKPartiallyApplied#apply.

    This method exists to allow the M and G parameters to be bound independently of the F and A parameters below.

  22. def liftT[S[_], M[_], A](value: M[A])(implicit M: Functor[M]): FreeT[S, M, A]
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. def pure[S[_], M[_], A](value: A)(implicit M: Applicative[M]): FreeT[S, M, A]

    Return the given value in the free monad.

  27. def roll[S[_], M[_], A](value: S[FreeT[S, M, A]])(implicit M: Applicative[M]): FreeT[S, M, A]
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def tailRecM[S[_], M[_], A, B](a: A)(f: (A) ⇒ FreeT[S, M, Either[A, B]])(implicit arg0: Applicative[M]): FreeT[S, M, B]
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def catsFreeMonadErrorForFreeT[S[_], M[_], E](implicit E: MonadError[M, E]): MonadError[[γ$9$]FreeT[S, M, γ$9$], E]
    Definition Classes
    FreeTInstances
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) does not handle errors beyond the head suspension; use catsFreeMonadErrorForFreeT2

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  3. def suspend[S[_], M[_], A](a: M[Either[A, S[FreeT[S, M, A]]]])(implicit M: Applicative[M]): FreeT[S, M, A]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.0.0-MF) Use FreeT.defer.

Inherited from Serializable

Inherited from Serializable

Inherited from FreeTInstances

Inherited from FreeTInstances0

Inherited from FreeTInstances1

Inherited from FreeTInstances2

Inherited from FreeTInstances3

Inherited from AnyRef

Inherited from Any

Ungrouped