Trait/Object

org.atnos.eff

Interpret

Related Docs: object Interpret | package eff

Permalink

trait Interpret extends AnyRef

Support methods to create an interpreter (or "effect handlers") for a given Eff[M |: R, A]. The aim being to "consume" just that effect and produce a value of type B with possibly other effects: Eff[R, B]

Those methods guarantee a stack-safe behaviour when running on a large list of effects (in a list.traverseU(f) for example).

There are 3 different types of supported interpreters:

  1. interpret + Recurse

This interpreter is used to handle effects which either return a value X from M[X] or stops with Eff[R, B] See an example of such an interpreter in Eval where we just evaluate a computation X for each Eval[X].

2. interpretState + StateRecurse

This interpreter is used to handle effects which either return a value X from M[X] or stops with Eff[R, B]

3. interpretLoop + Loop

The most generic kind of interpreter where we can even recurse in the case of Pure(a) (See ListEffect for such a use)

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Interpret
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Loop[M[_], R, A, B] extends AnyRef

    Permalink

    Generalisation of Recurse and StateRecurse

  2. trait Recurse[M[_], R, A] extends AnyRef

    Permalink

    Helper trait for computations which might produce several M[X] in a stack of effects.

    Helper trait for computations which might produce several M[X] in a stack of effects.

    Either we can produce an X to pass to a continuation or we're done

  3. trait SideEffect[T[_]] extends AnyRef

    Permalink
  4. trait StateRecurse[M[_], A, B] extends AnyRef

    Permalink

    Helper trait for computations which might produce several M[X] in a stack of effects and which need to keep some state around

    Helper trait for computations which might produce several M[X] in a stack of effects and which need to keep some state around

    This is typically the case for Writer or State which need to keep some state S after each evaluation Evaluating the effect M[X] might use the previous S value as shown in the apply method

    Finally when the Eff[M |: R, A] returns an A, this one can be combined with the last state value to produce a B

  5. trait StatelessLoop[M[_], R, A, B] extends AnyRef

    Permalink

    Generalisation of Recurse

  6. trait Translate[T[_], U] extends AnyRef

    Permalink

    trait for translating one effect into other ones in the same stack

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. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def intercept[R, M[_], A, B](pure: (A) ⇒ Eff[R, B], recurse: Recurse[M, R, B])(effects: Eff[R, A])(implicit m: Member[M, R]): Eff[R, B]

    Permalink

    INTERPRET IN THE SAME STACK

  12. def intercept1[R, M[_], A, B](pure: (A) ⇒ B)(recurse: Recurse[M, R, B])(effects: Eff[R, A])(implicit m: Member[M, R]): Eff[R, B]

    Permalink

    simpler version of intercept where the pure value is just mapped to another type

  13. def interceptLoop[R, M[_], A, B, S](pure: (A) ⇒ Eff[R, B], loop: Loop[M, R, A, Eff[R, B]])(effects: Eff[R, A])(implicit m: Member[M, R]): Eff[R, B]

    Permalink

    intercept an effect and interpret it in the same stack.

    intercept an effect and interpret it in the same stack. This method is stack-safe

  14. def interceptLoop1[R, M[_], A, B, S](pure: (A) ⇒ B)(loop: Loop[M, R, A, Eff[R, B]])(effects: Eff[R, A])(implicit m: Member[M, R]): Eff[R, B]

    Permalink
  15. def interceptStatelessLoop[R, M[_], A, B](pure: (A) ⇒ Eff[R, B], loop: StatelessLoop[M, R, A, Eff[R, B]])(effects: Eff[R, A])(implicit m: Member[M, R]): Eff[R, B]

    Permalink
  16. def interceptStatelessLoop1[R, M[_], A, B](pure: (A) ⇒ B)(loop: StatelessLoop[M, R, A, Eff[R, B]])(effects: Eff[R, A])(implicit m: Member[M, R]): Eff[R, B]

    Permalink
  17. def interpret[R, U, M[_], A, B](pure: (A) ⇒ Eff[U, B], recurse: Recurse[M, U, B])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink

    interpret the effect M in the M |: R stack

  18. def interpret1[R, U, M[_], A, B](pure: (A) ⇒ B)(recurse: Recurse[M, U, B])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink

    simpler version of interpret where the pure value is just mapped to another type

  19. def interpretLoop[R, U, M[_], A, B, S](pure: (A) ⇒ Eff[U, B], loop: Loop[M, R, A, Eff[U, B]])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink

    generalization of interpret and interpretState

    generalization of interpret and interpretState

    This method contains a loop which is stack-safe

  20. def interpretLoop1[R, U, M[_], A, B, S](pure: (A) ⇒ B)(loop: Loop[M, R, A, Eff[U, B]])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink
  21. def interpretState[R, U, M[_], A, B](pure: (A) ⇒ Eff[U, B], recurse: StateRecurse[M, A, B])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink

    interpret the effect M in the M |: R stack, keeping track of some state

  22. def interpretState1[R, U, M[_], A, B](pure: (A) ⇒ B)(recurse: StateRecurse[M, A, B])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink

    simpler version of interpret1 where the pure value is just mapped to another type

  23. def interpretStatelessLoop[R, U, M[_], A, B](pure: (A) ⇒ Eff[U, B], loop: StatelessLoop[M, R, A, Eff[U, B]])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink

    generalization of interpret

    generalization of interpret

    This method contains a loop which is stack-safe

  24. def interpretStatelessLoop1[R, U, M[_], A, B, S](pure: (A) ⇒ B)(loop: StatelessLoop[M, R, A, Eff[U, B]])(effects: Eff[R, A])(implicit m: Aux[M, R, U]): Eff[U, B]

    Permalink
  25. def interpretUnsafe[R, U, T[_], A](effects: Eff[R, A])(sideEffect: SideEffect[T])(implicit m: Aux[T, R, U]): Eff[U, A]

    Permalink

    interpret an effect by running side-effects

  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  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. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  32. def transform[SR, BR, U, TS[_], TB[_], A](r: Eff[SR, A], nat: NaturalTransformation[TS, TB])(implicit sr: Aux[TS, SR, U], br: Aux[TB, BR, U]): Eff[BR, A]

    Permalink

    transform an effect into another one using a natural transformation

  33. def translate[R, U, T[_], A](effects: Eff[R, A])(tr: Translate[T, U])(implicit m: Aux[T, R, U]): Eff[U, A]

    Permalink

    Translate one effect of the stack into some of the other effects in the stack

  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( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped