Package

org.atnos

eff

Permalink

package eff

Visibility
  1. Public
  2. All

Type Members

  1. case class Arrs[R, A, B](functions: Vector[(Any) ⇒ Eff[R, Any]]) extends Product with Serializable

    Permalink

    Sequence of monadic functions from A to B: A => Eff[B]

    Sequence of monadic functions from A to B: A => Eff[B]

    Internally it is represented as a Vector of functions:

    A => Eff[R, X1]; X1 => Eff[R, X2]; X2 => Eff[R, X3]; ...; X3 => Eff[R, B]

  2. trait DisjunctionCreation extends AnyRef

    Permalink
  3. trait DisjunctionImplicits extends DisjunctionImplicitsLower

    Permalink
  4. trait DisjunctionImplicitsLower extends AnyRef

    Permalink
  5. trait DisjunctionInterpretation extends AnyRef

    Permalink
  6. sealed trait Eff[R, A] extends AnyRef

    Permalink

    Effects of type R, returning a value of type A

    Effects of type R, returning a value of type A

    It is implemented as a "Free-er" monad with extensible effects:

    • the "pure" case is a pure value of type A
    • the "impure" case is:
      • a disjoint union of possible effects
      • a continuation of type X => Eff[R, A] indicating what to do if the current effect is of type M[X] this type is represented by the Arrs type

    The monad implementation for this type is really simple:

    • point is Pure
    • bind simply appends the binding function to the Arrs continuation

    Important:

    The list of continuations is NOT implemented as a type sequence but simply as a Vector[Any => Eff[R, Any]]

    This means that various .asInstanceOf are present in the implementation and could lead to burns and severe harm. Use with caution!

    See also

    http://okmij.org/ftp/Haskell/extensible/more.pdf

  7. sealed trait Effect[F[_]] extends AnyRef

    Permalink

    one effect, basically a type constructor

  8. trait Effects extends AnyRef

    Permalink

    Effects is a type level representing a list of effects which might take place in a computation

    Effects is a type level representing a list of effects which might take place in a computation

    Note that each "effect" is a type constructor

  9. final case class EffectsCons[F[_], T <: Effects](head: Effect[F], tail: T) extends Effects with Product with Serializable

    Permalink

    Append an effect at the beginning of a list of effects

  10. trait ErrorCreation[F] extends ErrorTypes[F]

    Permalink
  11. trait ErrorEffect[F] extends ErrorCreation[F] with ErrorInterpretation[F]

    Permalink

    Effect for computation which can fail and return a Throwable, or just stop with a failure

    Effect for computation which can fail and return a Throwable, or just stop with a failure

    This effect is a mix of Eval and Disjunction in the sense that every computation passed to this effect (with the ok method) is considered "impure" or "faulty" by default.

    The type F is used to represent the failure type.

  12. trait ErrorInterpretation[F] extends ErrorCreation[F]

    Permalink
  13. trait ErrorTypes[F] extends AnyRef

    Permalink
  14. case class Impure[R, X, A](union: Union[R, X], continuation: Arrs[R, X, A]) extends Eff[R, A] with Product with Serializable

    Permalink

    union is a disjoint union of effects returning a value of type X (not specified)

  15. trait Interpret extends AnyRef

    Permalink

    Support methods to create an interpreter (or "effect handlers") for a given Eff[M |: R, A].

    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)

  16. trait IntoPoly[R <: Effects, U, A] extends AnyRef

    Permalink

    Trait for polymorphic recursion into Eff[?, A]

    Trait for polymorphic recursion into Eff[?, A]

    The idea is to deal with one effect at the time:

    • if the effect stack is M |: R and if U contains M we transform each "Union[R, X]" in the Impure case into a Union for U and we try to recurse on other effects present in R
    • if the effect stack is M |: NoEffect and if U contains M we just "inject" the M[X] effect into Eff[U, A] using the Member typeclass if M is not present when we decompose we throw an exception. This case should never happen because if there is no other effect in the stack there should be at least something producing a value of type A
  17. trait IntoPolyLower extends AnyRef

    Permalink
  18. trait Member[T[_], R] extends AnyRef

    Permalink

    Member typeclass for effects belonging to a stack of effects R

    Member typeclass for effects belonging to a stack of effects R

    If T is a member of R then we can:

    - create a Union of effects from a single effect with "inject" - extract an effect value from a union if there is such an effect in the stack

  19. trait MemberImplicits extends MemberImplicits1

    Permalink
  20. trait MemberImplicits1 extends MemberImplicits2

    Permalink
  21. trait MemberImplicits2 extends AnyRef

    Permalink
  22. class NoEffect extends Effects

    Permalink

    Nil case for the list of effects

  23. case class Pure[R, A](value: A) extends Eff[R, A] with Product with Serializable

    Permalink
  24. trait ReaderCreation extends AnyRef

    Permalink
  25. trait ReaderEffect extends ReaderCreation with ReaderInterpretation with ReaderImplicits

    Permalink

    Effect for computations depending on an environment.

    Effect for computations depending on an environment.

    The inside datatype for this effect is scalaz.Reader

    Several Reader effects can be present in a given stack provided that they are tagged with scala.Tag.

    A tagged Reader effect can be run with runTaggedReader

  26. trait ReaderImplicits extends ReaderImplicits1

    Permalink
  27. trait ReaderImplicits1 extends AnyRef

    Permalink
  28. trait ReaderInterpretation extends AnyRef

    Permalink
  29. trait StateCreation extends AnyRef

    Permalink
  30. trait StateEffect extends StateCreation with StateInterpretation with StateImplicits

    Permalink

    Effect for passing state along computations

    Effect for passing state along computations

    Several state effects can be used in the same stack if they are tagged

    Internally backed up by scalaz.State

  31. trait StateImplicits extends StateImplicits1

    Permalink
  32. trait StateImplicits1 extends AnyRef

    Permalink
  33. trait StateInterpretation extends AnyRef

    Permalink
  34. sealed trait Union[+R, A] extends AnyRef

    Permalink

    Open union of effects

    Open union of effects

    They are modelled as a list of

    UnionNext(UnionNext(...(UnionNow(M[X])))

    where M[X] is an effect. The depth of the nesting in an Union value corresponds to the place of the effect in a type E1 |: E2 |: E3 |: .. |: NoEffect

  35. case class UnionNext[O[_], R <: Effects, A](u: Union[R, A]) extends Union[|:[O, R], A] with Product with Serializable

    Permalink
  36. case class UnionNow[T[_], R <: Effects, A](ta: T[A]) extends Union[|:[T, R], A] with Product with Serializable

    Permalink
  37. trait WriterCreation extends AnyRef

    Permalink
  38. trait WriterEffect extends WriterCreation with WriterInterpretation with WriterImplicits

    Permalink

    Effect for logging values alongside computations

    Effect for logging values alongside computations

    Compared to traditional Writer monad which accumulates values by default this effect can be interpreted in different ways:

    • log values to the console or to a file as soon as they are produced
    • accumulate values in a list

    Several writer effects can be used in the same stack if they are tagged.

  39. trait WriterImplicits extends WriterImplicits1

    Permalink
  40. trait WriterImplicits1 extends AnyRef

    Permalink
  41. trait WriterInterpretation extends AnyRef

    Permalink

Value Members

  1. object Arrs extends Serializable

    Permalink
  2. object DisjunctionEffect extends DisjunctionCreation with DisjunctionInterpretation with DisjunctionImplicits

    Permalink

    Effect for computation which can fail

  3. object DisjunctionImplicits extends DisjunctionImplicits

    Permalink
  4. object Eff

    Permalink
  5. object Effects

    Permalink

    Aliases for declaring effects with the following syntax

    Aliases for declaring effects with the following syntax

    A |: B |: C |: NoEffect

  6. object ErrorEffect extends ErrorEffect[String]

    Permalink

    Simple instantiation of the ErrorEffect trait with String as a Failure type

  7. object EvalEffect

    Permalink

    Effect for delayed computations

    Effect for delayed computations

    uses scalaz.Need as a supporting data structure

  8. object Interpret extends Interpret

    Permalink
  9. object IntoPoly extends IntoPolyLower

    Permalink
  10. object ListEffect

    Permalink

    Effect for computations possibly returning several values

  11. object Member extends MemberImplicits

    Permalink
  12. object NoEffect extends NoEffect

    Permalink
  13. object OptionEffect

    Permalink

    Effect for optional computations

  14. object ReaderCreation extends ReaderCreation

    Permalink
  15. object ReaderEffect extends ReaderEffect

    Permalink
  16. object ReaderImplicits extends ReaderImplicits

    Permalink
  17. object ReaderInterpretation extends ReaderInterpretation

    Permalink
  18. object StateCreation extends StateCreation

    Permalink
  19. object StateEffect extends StateEffect

    Permalink
  20. object StateImplicits extends StateImplicits

    Permalink
  21. object StateInterpretation extends StateInterpretation

    Permalink
  22. object Union

    Permalink

    create union objects

  23. object WriterCreation extends WriterCreation

    Permalink
  24. object WriterEffect extends WriterEffect

    Permalink
  25. object WriterImplicits extends WriterImplicits

    Permalink
  26. object WriterInterpretation extends WriterInterpretation

    Permalink
  27. package syntax

    Permalink

Ungrouped