Free

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 >>=[B](f: (A) ⇒ Free[S, B]): Free[S, B]

   

   Alias for flatMap

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. final def bounce(f: (S[Free[S, A]]) ⇒ Free[S, A])(implicit S: Functor[S]): Free[S, A]

   

   Runs a single step, using a function that extracts the resumption from its suspension functor.

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def collect[B](implicit ev: =:=[Free[S, A], Source[B, A]]): (Vector[B], A)

   

   Runs a Source all the way to the end, tail-recursively, collecting the produced values.

9. def drain[E, B](source: Source[E, B])(implicit ev: =:=[Free[S, A], Sink[E, A]]): (A, B)

   

   Feed the given source to this Sink.

10. def drive[E, B](sink: Sink[Option[E], B])(implicit ev: =:=[Free[S, A], Source[E, A]]): (A, B)

    

    Drive this Source with the given Sink.

11. def duplicateF(implicit S: Functor[S]): Free[[a]Free[S, a], A]

    

    Duplication in Free as a comonad in the endofunctor category.

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

    

    Definition Classes

    AnyRef

13. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

14. def extendF[T[_]](f: ~>[[a]Free[S, a], T])(implicit S: Functor[S], T: Functor[T]): Free[T, A]

    

    Extension in Free as a comonad in the endofunctor category.

15. def extractF(implicit S: Monad[S]): S[A]

    

    Extraction from Free as a comonad in the endofunctor category.

16. def feed[E](ss: Stream[E])(implicit ev: =:=[Free[S, A], Sink[E, A]]): A

    

    Feed the given stream to this Source.

17. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

18. final def flatMap[B](f: (A) ⇒ Free[S, B]): Free[S, B]

    

    Binds the given continuation to the result of this computation.

    Binds the given continuation to the result of this computation. All left-associated binds are reassociated to the right.

19. final def flatMapSuspension[T[_]](f: ~>[S, [α]Free[T, α]])(implicit S: Functor[S]): Free[T, A]

    

    Substitutes a free monad over the given functor into the suspension functor of this program.

    Substitutes a free monad over the given functor into the suspension functor of this program. Free is a monad in an endofunctor category and this is its monadic bind.

20. final def fold[B](r: (A) ⇒ B, s: (S[Free[S, A]]) ⇒ B)(implicit S: Functor[S]): B

    

    Catamorphism.

    Catamorphism. Run the first given function if Return, otherwise, the second given function.

21. final def foldMap[M[_]](f: ~>[S, M])(implicit S: Functor[S], M: Monad[M]): M[A]

    

    Catamorphism for Free.

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

22. final def foldRight[G[_]](z: ~>[Id.Id, G])(f: ~>[[α]S[G[α]], G])(implicit S: Functor[S]): G[A]

    

    Folds this free recursion to the right using the given natural transformations.

23. final def foldRun[B](b: B)(f: (B, S[Free[S, A]]) ⇒ (B, Free[S, A]))(implicit S: Functor[S]): (B, A)

    

    Runs to completion, allowing the resumption function to thread an arbitrary state of type B.

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

    

    Definition Classes

    AnyRef → Any

25. final def go(f: (S[Free[S, A]]) ⇒ Free[S, A])(implicit S: Functor[S]): A

    

    Runs to completion, using a function that extracts the resumption from its suspension functor.

26. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

27. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

28. final def map[B](f: (A) ⇒ B): Free[S, B]

    

29. final def mapFirstSuspension(f: ~>[S, S])(implicit S: Functor[S]): Free[S, A]

    

    Modifies the first suspension with the given natural transformation.

30. final def mapSuspension[T[_]](f: ~>[S, T])(implicit S: Functor[S], T: Functor[T]): Free[T, A]

    

    Changes the suspension functor by the given natural transformation.

31. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

32. final def notify(): Unit

    

    Definition Classes

    AnyRef

33. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

34. final def resume(implicit S: Functor[S]): \/[S[Free[S, A]], A]

    

    Evaluates a single layer of the free monad *

    Evaluates a single layer of the free monad *

    Annotations

    @tailrec()

35. def run(implicit ev: =:=[Free[S, A], Trampoline[A]]): A

    

    Runs a trampoline all the way to the end, tail-recursively.

36. final def runM[M[_]](f: (S[Free[S, A]]) ⇒ M[Free[S, 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.

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

    Since

    7.0.1

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

    

    Definition Classes

    AnyRef

38. def toString(): String

    

    Definition Classes

    AnyRef → Any

39. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

40. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

41. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

42. final def zap[G[_], B](fs: Cofree[G, (A) ⇒ B])(implicit S: Functor[S], G: Functor[G], d: Zap[S, G]): B

    

    Applies a function in a comonad to the corresponding value in this monad, annihilating both.

43. final def zapWith[G[_], B, C](bs: Cofree[G, B])(f: (A, B) ⇒ C)(implicit S: Functor[S], G: Functor[G], d: Zap[S, G]): C

    

    Applies a function f to a value in this monad and a corresponding value in the dual comonad, annihilating both.

44. def zipWith[B, C](tb: Free[S, B])(f: (A, B) ⇒ C)(implicit S: Functor[S]): Free[S, C]

    

    Interleave this computation with another, combining the results with the given function.