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

sealed abstract class FreeT[S[_], M[_], A] extends Product with Serializable

FreeT is a monad transformer for Free monads over a Functor S

Stack safety for Free and FreeT is based on the paper Stack Safety for Free by Phil Freeman

This Scala implementation of FreeT and its usages are derived from Scalaz's FreeT, originally written by Brian McKenna.

Source
FreeT.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FreeT
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def productArity: Int
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any
    Definition Classes
    Product

Concrete 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. def compile[T[_]](st: FunctionK[S, T])(implicit M: Functor[M]): FreeT[T, M, A]

    Change the base functor S for a FreeT action.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def flatMap[B](f: (A) ⇒ FreeT[S, M, B]): FreeT[S, M, B]

    Binds the given continuation to the result of this computation.

  10. def flatMapK[N[_]](mn: ~>[M, [γ$0$]FreeT[S, N, γ$0$]])(implicit S: Functor[S], N: Monad[N]): FreeT[S, N, A]

    Modify the context M using the transformation mn, flattening the free suspensions into the outer.

  11. def foldMap(f: FunctionK[S, M])(implicit M: Monad[M]): M[A]

    Runs to completion, mapping the suspension with the given transformation at each step and accumulating into the monad M.

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def hoist[N[_]](mn: FunctionK[M, N]): FreeT[S, N, A]

    Changes the underlying Monad for this FreeT, ie.

    Changes the underlying Monad for this FreeT, ie. turning this FreeT[S, M, A] into a FreeT[S, N, A].

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def map[B](f: (A) ⇒ B)(implicit M: Applicative[M]): FreeT[S, M, B]
  17. def mapK[N[_]](mn: ~>[M, N]): FreeT[S, N, A]

    Modify the context M using transformation mn.

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def productIterator: Iterator[Any]
    Definition Classes
    Product
  22. def productPrefix: String
    Definition Classes
    Product
  23. def resume(implicit S: Functor[S], M: Monad[M]): M[Either[S[FreeT[S, M, A]], A]]

    Evaluates a single layer of the free monad

  24. def runM(interp: (S[FreeT[S, M, A]]) ⇒ M[FreeT[S, M, A]])(implicit S: Functor[S], M: Monad[M]): M[A]

    Runs to completion, using a function that maps the resumption from S to a monad M.

  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    FreeT → AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped