Object/Class

cats.free

Free

Related Docs: class Free | package free

Permalink

object Free extends FreeInstances with Serializable

Linear Supertypes
Serializable, Serializable, FreeInstances, FreeInstances1, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Free
  2. Serializable
  3. Serializable
  4. FreeInstances
  5. FreeInstances1
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. implicit def catsFreeDeferForFree[S[_]]: Defer[[β$21$]Free[S, β$21$]]

    Permalink
    Definition Classes
    FreeInstances
  6. implicit def catsFreeDeferForId: Defer[[β$15$]Free[[A]A, β$15$]]

    Permalink
  7. implicit def catsFreeFoldableForFree[F[_]](implicit foldableF: Foldable[F]): Foldable[[β$23$]Free[F, β$23$]]

    Permalink
    Definition Classes
    FreeInstances1
  8. implicit def catsFreeMonadForFree[S[_]]: Monad[[β$18$]Free[S, β$18$]]

    Permalink

    Free[S, ?] has a monad for any type constructor S[_].

    Free[S, ?] has a monad for any type constructor S[_].

    Definition Classes
    FreeInstances
  9. implicit def catsFreeMonadForId: Monad[[β$14$]Free[[A]A, β$14$]]

    Permalink
  10. implicit def catsFreeTraverseForFree[F[_]](implicit traversableF: Traverse[F]): Traverse[[β$24$]Free[F, β$24$]]

    Permalink
    Definition Classes
    FreeInstances1
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def compile[F[_], G[_]](fk: FunctionK[F, G]): FunctionK[[β$9$]Free[F, β$9$], [β$10$]Free[G, β$10$]]

    Permalink

    a FunctionK, suitable for composition, which calls compile

  13. def defer[F[_], A](value: ⇒ Free[F, A]): Free[F, A]

    Permalink

    Defer the creation of a Free[F, A] value.

  14. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def foldMap[F[_], M[_]](fk: FunctionK[F, M])(implicit arg0: Monad[M]): FunctionK[[β$11$]Free[F, β$11$], M]

    Permalink

    a FunctionK, suitable for composition, which calls foldMap

  18. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def inject[F[_], G[_]]: FreeInjectKPartiallyApplied[F, G]

    Permalink

    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 FreeInjectKPartiallyApplied#apply.

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

  21. def injectRoll[F[_], G[_], A](ga: G[Free[F, A]])(implicit I: InjectK[G, F]): Free[F, A]

    Permalink
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def liftF[F[_], A](value: F[A]): Free[F, A]

    Permalink

    Lift an F[A] value into the free monad.

  24. def liftInject[G[_]]: FreeLiftInjectKPartiallyApplied[G]

    Permalink

    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 FreeLiftInjectKPartiallyApplied#apply.

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

  25. def mapK[F[_], G[_]](fk: FunctionK[F, G]): FunctionK[[β$4$]Free[F, β$4$], [β$5$]Free[G, β$5$]]

    Permalink

    a FunctionK, suitable for composition, which calls mapK

  26. def match_[F[_], G[_], A](fa: Free[F, A])(implicit F: Functor[F], I: InjectK[G, F]): Option[G[Free[F, A]]]

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

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

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

    Permalink
    Definition Classes
    AnyRef
  30. def pure[S[_], A](a: A): Free[S, A]

    Permalink

    Lift a pure A value into the free monad.

  31. def roll[F[_], A](value: F[Free[F, A]]): Free[F, A]

    Permalink

    Absorb a step into the free monad.

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

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

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

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

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

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

Deprecated Value Members

  1. def suspend[F[_], A](value: ⇒ Free[F, A]): Free[F, A]

    Permalink

    Suspend the creation of a Free[F, A] value.

    Suspend the creation of a Free[F, A] value.

    Annotations
    @deprecated
    Deprecated

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

Inherited from Serializable

Inherited from Serializable

Inherited from FreeInstances

Inherited from FreeInstances1

Inherited from AnyRef

Inherited from Any

Ungrouped