Package

org.atnos

eff

Permalink

package eff

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

Type Members

  1. type <=[M[_], R] = Member[M, R]

    Permalink
  2. 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]

  3. sealed trait Choose[T] extends AnyRef

    Permalink
  4. trait ChooseCreation extends AnyRef

    Permalink
  5. trait ChooseEffect extends ChooseCreation with ChooseInterpretation

    Permalink

    The Choose effect models non-determinism So we can get results, either:

    The Choose effect models non-determinism So we can get results, either:

    • no results (when using ChooseZero)
    • the result for action1 or the result for action b (when using ChoosePlus)

    When running this effect we can "collect" the results with any F which has an Alternative instance.

    For example if F is List then:

    • no results is the empty list
    • the result for a or b is List(a, b)

    If F is Option then:

    • no results is the None
    • the result for a or b is Some(a) or Some(b
  6. trait ChooseImplicits extends AnyRef

    Permalink
  7. trait ChooseInterpretation extends AnyRef

    Permalink
  8. case class ChooseZero[T]() extends Choose[T] with Product with Serializable

    Permalink
  9. case class Correct[E]() extends Validate[E, Unit] with Product with Serializable

    Permalink
  10. 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

  11. trait EffCreation extends AnyRef

    Permalink
  12. trait EffImplicits extends AnyRef

    Permalink
  13. trait EffInterpretation extends AnyRef

    Permalink
  14. sealed trait Effect[F[_]] extends AnyRef

    Permalink

    one effect, basically a type constructor

  15. 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

  16. 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

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

    Permalink
  18. 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 Xor 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.

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

    Permalink
  20. trait ErrorTypes[F] extends AnyRef

    Permalink
  21. trait EvalCreation extends EvalTypes

    Permalink
  22. trait EvalEffect extends EvalTypes with EvalCreation with EvalInterpretation

    Permalink

    Effect for delayed computations

    Effect for delayed computations

    uses cats.Eval as a supporting data structure

  23. trait EvalInterpretation extends EvalTypes

    Permalink
  24. trait EvalTypes extends AnyRef

    Permalink
  25. trait Fold[A, B] extends AnyRef

    Permalink

    support trait for folding values while possibly keeping some internal state

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

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

  28. 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
  29. trait IntoPolyLower extends AnyRef

    Permalink
  30. trait ListCreation extends AnyRef

    Permalink
  31. trait ListEffect extends ListCreation with ListInterpretation

    Permalink

    Effect for computations possibly returning several values

  32. trait ListInterpretation extends AnyRef

    Permalink
  33. 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

    Annotations
    @implicitNotFound( ... )
  34. trait MemberImplicits extends MemberImplicits1

    Permalink
  35. trait MemberImplicits1 extends MemberImplicits2

    Permalink
  36. trait MemberImplicits2 extends AnyRef

    Permalink
  37. class NoEffect extends Effects

    Permalink

    Nil case for the list of effects

  38. trait OptionCreation extends AnyRef

    Permalink
  39. trait OptionEffect extends OptionCreation with OptionInterpretation

    Permalink

    Effect for optional computations

  40. trait OptionInterpretation extends AnyRef

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

    Permalink
  42. trait ReaderCreation extends AnyRef

    Permalink
  43. 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

  44. trait ReaderImplicits extends ReaderImplicits1

    Permalink
  45. trait ReaderImplicits1 extends AnyRef

    Permalink
  46. trait ReaderInterpretation extends AnyRef

    Permalink
  47. trait StateCreation extends AnyRef

    Permalink
  48. 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 cats.data.State

  49. trait StateImplicits extends StateImplicits1

    Permalink
  50. trait StateImplicits1 extends AnyRef

    Permalink
  51. trait StateInterpretation extends AnyRef

    Permalink
  52. 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

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

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

    Permalink
  55. sealed trait Validate[+E, A] extends AnyRef

    Permalink
  56. trait ValidateCreation extends AnyRef

    Permalink
  57. trait ValidateEffect extends ValidateCreation with ValidateInterpretation

    Permalink

    Effect for computation which can fail but will accumulate errors

    Effect for computation which can fail but will accumulate errors

    The runValidate interpreter just collects the messages and returns them at the end

  58. trait ValidateImplicits extends ValidateImplicits1

    Permalink
  59. trait ValidateImplicits1 extends AnyRef

    Permalink
  60. trait ValidateInterpretation extends ValidateCreation

    Permalink
  61. trait WriterCreation extends AnyRef

    Permalink
  62. 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.

  63. trait WriterImplicits extends WriterImplicits1

    Permalink
  64. trait WriterImplicits1 extends AnyRef

    Permalink
  65. trait WriterInterpretation extends AnyRef

    Permalink
  66. case class Wrong[E](e: E) extends Validate[E, Unit] with Product with Serializable

    Permalink
  67. trait XorCreation extends AnyRef

    Permalink
  68. trait XorEffect extends XorCreation with XorInterpretation

    Permalink

    Effect for computation which can fail

  69. trait XorInterpretation extends AnyRef

    Permalink

Value Members

  1. object Arrs extends Serializable

    Permalink
  2. object BuildInfo

    Permalink
  3. object ChooseCreation extends ChooseCreation

    Permalink
  4. object ChooseEffect extends ChooseEffect

    Permalink
  5. object ChooseImplicits extends ChooseImplicits

    Permalink
  6. object ChooseInterpretation extends ChooseInterpretation

    Permalink
  7. object ChoosePlus extends Choose[Boolean] with Product with Serializable

    Permalink
  8. object Eff extends EffCreation with EffInterpretation with EffImplicits

    Permalink
  9. object EffCreation extends EffCreation

    Permalink
  10. object EffImplicits extends EffImplicits

    Permalink
  11. object EffInterpretation extends EffInterpretation

    Permalink
  12. object Effects extends Effects

    Permalink

    Aliases for declaring effects with the following syntax

    Aliases for declaring effects with the following syntax

    A |: B |: C |: NoEffect

  13. object ErrorEffect extends ErrorEffect[String]

    Permalink

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

  14. object EvalEffect extends EvalEffect

    Permalink
  15. object EvalInterpretation extends EvalInterpretation

    Permalink
  16. object EvalTypes extends EvalTypes

    Permalink
  17. object Interpret extends Interpret

    Permalink
  18. object IntoPoly extends IntoPolyLower

    Permalink
  19. object ListCreation extends ListCreation

    Permalink
  20. object ListEffect extends ListEffect

    Permalink
  21. object ListInterpretation extends ListInterpretation

    Permalink
  22. object Member extends MemberImplicits

    Permalink
  23. object NoEffect extends NoEffect

    Permalink
  24. object OptionCreation extends OptionCreation

    Permalink
  25. object OptionEffect extends OptionEffect

    Permalink
  26. object OptionInterpretation extends OptionInterpretation

    Permalink
  27. object ReaderCreation extends ReaderCreation

    Permalink
  28. object ReaderEffect extends ReaderEffect

    Permalink
  29. object ReaderImplicits extends ReaderImplicits

    Permalink
  30. object ReaderInterpretation extends ReaderInterpretation

    Permalink
  31. object StateCreation extends StateCreation

    Permalink
  32. object StateEffect extends StateEffect

    Permalink
  33. object StateImplicits extends StateImplicits

    Permalink
  34. object StateInterpretation extends StateInterpretation

    Permalink
  35. object Tag

    Permalink

    Taken from Scalaz

  36. object Union

    Permalink

    create union objects

  37. object ValidateCreation extends ValidateCreation

    Permalink
  38. object ValidateEffect extends ValidateEffect

    Permalink
  39. object ValidateImplicits extends ValidateImplicits

    Permalink
  40. object ValidateInterpretation extends ValidateInterpretation

    Permalink
  41. object WriterCreation extends WriterCreation

    Permalink
  42. object WriterEffect extends WriterEffect

    Permalink
  43. object WriterImplicits extends WriterImplicits

    Permalink
  44. object WriterInterpretation extends WriterInterpretation

    Permalink
  45. object XorCreation extends XorCreation

    Permalink
  46. object XorEffect extends XorEffect

    Permalink
  47. object XorInterpretation extends XorInterpretation

    Permalink
  48. object all extends ReaderEffect with WriterEffect with StateEffect with EvalEffect with OptionEffect with ListEffect with XorEffect with ValidateEffect with ChooseEffect with EffInterpretation with EffCreation with EffImplicits with Effects

    Permalink
  49. object choose extends ChooseCreation with ChooseInterpretation

    Permalink
  50. object eff extends EffCreation with EffInterpretation with Effects

    Permalink
  51. object eval extends EvalCreation with EvalInterpretation

    Permalink
  52. object interpret extends Interpret

    Permalink
  53. object list extends ListCreation with ListInterpretation

    Permalink
  54. object option extends OptionCreation with OptionInterpretation

    Permalink
  55. object reader extends ReaderCreation with ReaderInterpretation

    Permalink
  56. object state extends StateCreation with StateInterpretation

    Permalink
  57. package syntax

    Permalink
  58. object validate extends ValidateCreation with ValidateInterpretation

    Permalink
  59. object writer extends WriterCreation with WriterInterpretation

    Permalink
  60. object xor extends XorCreation with XorInterpretation

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped