object Free extends FreeInstances with Serializable
- Source
- Free.scala
- Alphabetic
- By Inheritance
- Free
- Serializable
- Serializable
- FreeInstances
- FreeStructuralInstances
- FreeInstances1
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
implicit
def
catsFreeDeferForFree[S[_]]: Defer[[β$23$]Free[S, β$23$]]
- Definition Classes
- FreeInstances
- implicit def catsFreeDeferForId: Defer[[β$17$]Free[[A]A, β$17$]]
-
implicit
def
catsFreeFoldableForFree[F[_]](implicit foldableF: Foldable[F]): Foldable[[β$25$]Free[F, β$25$]]
- Definition Classes
- FreeInstances1
-
implicit
def
catsFreeMonadForFree[S[_]]: Monad[[β$20$]Free[S, β$20$]]
Free[S, *]
has a monad for any type constructorS[_]
.Free[S, *]
has a monad for any type constructorS[_]
.- Definition Classes
- FreeInstances
- implicit def catsFreeMonadForId: Monad[[β$16$]Free[[A]A, β$16$]]
-
implicit
def
catsFreeTraverseForFree[F[_]](implicit traversableF: Traverse[F]): Traverse[[β$26$]Free[F, β$26$]]
- Definition Classes
- FreeInstances1
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @IntrinsicCandidate()
-
def
compile[F[_], G[_]](fk: FunctionK[F, G]): FunctionK[[β$12$]Free[F, β$12$], [β$13$]Free[G, β$13$]]
a FunctionK, suitable for composition, which calls compile
-
def
defer[F[_], A](value: ⇒ Free[F, A]): Free[F, A]
Defer the creation of a
Free[F, A]
value. -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
foldMap[F[_], M[_]](fk: FunctionK[F, M])(implicit arg0: Monad[M]): FunctionK[[β$14$]Free[F, β$14$], M]
a FunctionK, suitable for composition, which calls foldMap
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def injectRoll[F[_], G[_], A](ga: G[Free[F, A]])(implicit I: InjectK[G, F]): Free[F, A]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
liftF[F[_], A](value: F[A]): Free[F, A]
Lift an
F[A]
value into the free monad. -
def
liftId[F[_]]: ~>[Id, [β$6$]Free[F, β$6$]]
Same as pure but expressed as a FunctionK
Same as pure but expressed as a FunctionK
scala> import cats._ scala> val fo = Free.liftId[Eval]("foo") val fo: cats.free.Free[Eval,String] = Free(...)
-
def
liftInject[G[_]]: FreeLiftInjectKPartiallyApplied[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
FreeLiftInjectKPartiallyApplied#apply
.This method exists to allow the
G
parameter to be bound independently of theF
andA
parameters below. -
def
liftK[F[_]]: ~>[F, [β$4$]Free[F, β$4$]]
Same as liftF, but expressed as a FunctionK for use with mapK
Same as liftF, but expressed as a FunctionK for use with mapK
scala> import cats._, data._, implicits._ scala> val a: OptionT[Eval, Int] = 1.pure[OptionT[Eval, *]] scala> val b: OptionT[Free[Eval, *], Int] = a.mapK(Free.liftK) scala> b.value.run res0: Option[Int] = Some(1)
-
def
mapK[F[_], G[_]](fk: FunctionK[F, G]): FunctionK[[β$8$]Free[F, β$8$], [β$9$]Free[G, β$9$]]
a FunctionK, suitable for composition, which calls mapK
- def match_[F[_], G[_], A](fa: Free[F, A])(implicit F: Functor[F], I: InjectK[G, F]): Option[G[Free[F, A]]]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
def
pure[S[_], A](a: A): Free[S, A]
Lift a pure
A
value into the free monad. -
def
roll[F[_], A](value: F[Free[F, A]]): Free[F, A]
Absorb a step into the free monad.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
-
def
inject[F[_], G[_]]: FreeInjectKPartiallyApplied[F, 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
FreeInjectKPartiallyApplied#apply
.This method exists to allow the
F
andG
parameters to be bound independently of theA
parameter below.- Annotations
- @deprecated
- Deprecated
(Since version 2.3.1) use liftInject
-
def
suspend[F[_], A](value: ⇒ Free[F, A]): Free[F, A]
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.