cats-docs
2.10.0
API
Generated with
cats-docs/cats/cats.free/FreeT

FreeT

cats.free.FreeT$
See theFreeT companion class
object FreeT

Attributes

Companion
class
Source
FreeT.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
FreeT.type

Members list

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

def compile[S[_], T[_], M[_] : Functor](st: FunctionK[S, T]): FunctionK[[_] =>> FreeT[S, M, _$45], [_] =>> FreeT[T, M, _$46]]

Attributes

Source
FreeT.scala
def defer[S[_], M[_], A](a: M[Either[A, S[FreeT[S, M, A]]]])(implicit M: Applicative[M]): FreeT[S, M, A]

Attributes

Source
FreeT.scala
def foldMap[S[_], M[_] : Monad](fk: FunctionK[S, M]): FunctionK[[_] =>> FreeT[S, M, _$51], M]

Attributes

Source
FreeT.scala
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.

Attributes

Source
FreeT.scala
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.

Attributes

Source
FreeT.scala
def liftT[S[_], M[_], A](value: M[A])(implicit M: Functor[M]): FreeT[S, M, A]

Attributes

Source
FreeT.scala
def pure[S[_], M[_], A](value: A)(implicit M: Applicative[M]): FreeT[S, M, A]

Return the given value in the free monad.

Return the given value in the free monad.

Attributes

Source
FreeT.scala
def roll[S[_], M[_], A](value: S[FreeT[S, M, A]])(implicit M: Applicative[M]): FreeT[S, M, A]

Attributes

Source
FreeT.scala
def tailRecM[S[_], M[_] : Applicative, A, B](a: A)(f: A => FreeT[S, M, Either[A, B]]): FreeT[S, M, B]

Attributes

Source
FreeT.scala

Deprecated methods

def suspend[S[_], M[_], A](a: M[Either[A, S[FreeT[S, M, A]]]])(implicit M: Applicative[M]): FreeT[S, M, A]

Attributes

Deprecated
true
Source
FreeT.scala

Deprecated and Inherited methods

def catsFreeMonadErrorForFreeT[S[_], M[_], E](implicit E: MonadError[M, E]): MonadError[[_] =>> FreeT[S, M, _$60], E]

Attributes

Deprecated
true
Inherited from:
FreeTInstances (hidden)
Source
FreeT.scala

Implicits

Inherited implicits

implicit def catsDeferForFreeT[S[_], M[_] : Applicative]: Defer[[_] =>> FreeT[S, M, _$65]]

Attributes

Inherited from:
FreeTInstances (hidden)
Source
FreeT.scala
implicit def catsFreeAlternativeForFreeT[S[_], M[_] : Monad]: Alternative[[_] =>> FreeT[S, M, _$81]]

Attributes

Inherited from:
FreeTInstances2 (hidden)
Source
FreeT.scala
implicit def catsFreeFlatMapForFreeT[S[_], M[_]](implicit M0: Applicative[M]): FlatMap[[_] =>> FreeT[S, M, _$78]]

Attributes

Inherited from:
FreeTInstances1 (hidden)
Source
FreeT.scala
implicit def catsFreeMonadErrorForFreeT2[S[_], M[_], E](implicit E: MonadError[M, E], S: Functor[S]): MonadError[[_] =>> FreeT[S, M, _$70], E]

Attributes

Inherited from:
FreeTInstances (hidden)
Source
FreeT.scala
implicit def catsFreeMonadForFreeT[S[_], M[_]](implicit M0: Applicative[M]): Monad[[_] =>> FreeT[S, M, _$75]]

Attributes

Inherited from:
FreeTInstances0 (hidden)
Source
FreeT.scala
implicit def catsFreeSemigroupKForFreeT[S[_], M[_] : SemigroupK]: SemigroupK[[_] =>> FreeT[S, M, _$85]]

Attributes

Inherited from:
FreeTInstances3 (hidden)
Source
FreeT.scala
Generated with