Object

org.specs2.control.eff

all

Related Doc: package eff

Permalink

object all extends WriterEffect with SafeEffect with EffInterpretation with EffCreation with EffImplicits

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. all
  2. EffImplicits
  3. EffCreation
  4. EffInterpretation
  5. SafeEffect
  6. SafeInterpretation
  7. SafeCreation
  8. SafeTypes
  9. WriterEffect
  10. WriterInterpretation
  11. WriterCreation
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Out[A] = (Either[Throwable, A], List[Throwable])

    Permalink
    Definition Classes
    SafeInterpretation
  2. type _Safe[R] = Member[Safe, R]

    Permalink
    Definition Classes
    SafeTypes
  3. type _safe[R] = MemberIn[Safe, R]

    Permalink
    Definition Classes
    SafeTypes

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 EffApplicative[R]: Applicative[[β$6$]Eff[R, β$6$]]

    Permalink
    Definition Classes
    EffImplicits
  5. implicit final def EffMonad[R]: Monad[[β$4$]Eff[R, β$4$]]

    Permalink
    Definition Classes
    EffImplicits
  6. def IntoMonoidFold[M, A](f: (A) ⇒ M)(implicit arg0: Monoid[M]): RightFold[A, M]

    Permalink
    Definition Classes
    WriterInterpretation
  7. implicit def ListFold[A]: RightFold[A, List[A]]

    Permalink
    Definition Classes
    WriterInterpretation
  8. def MonoidFold[A](implicit arg0: Monoid[A]): RightFold[A, A]

    Permalink
    Definition Classes
    WriterInterpretation
  9. def ap[R, A, B](a: Eff[R, A])(f: Eff[R, (A) ⇒ B]): Eff[R, B]

    Permalink

    apply a function to an Eff value using the applicative instance

    apply a function to an Eff value using the applicative instance

    Definition Classes
    EffCreation
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def attempt[R, A](action: Eff[R, A])(implicit m: /=[Safe, R]): Eff[R, Either[Throwable, A]]

    Permalink

    try to execute an action an report any issue

    try to execute an action an report any issue

    Definition Classes
    SafeInterpretation
  12. def attemptSafe[R, A](effect: Eff[R, A])(implicit m: /=[Safe, R]): Eff[R, (Either[Throwable, A], List[Throwable])]

    Permalink

    Attempt to execute a safe action including finalizers

    Attempt to execute a safe action including finalizers

    Definition Classes
    SafeInterpretation
  13. def bracket[R, A, B, C](acquire: Eff[R, A])(use: (A) ⇒ Eff[R, B])(release: (A) ⇒ Eff[R, C])(implicit m: /=[Safe, R]): Eff[R, B]

    Permalink

    get a resource A and use it.

    get a resource A and use it. Call the release function whether an exception is thrown or not when using the resource

    NOTE: Eff interpreters are independent so if there is an effect short-circuiting all computations inside 'use', like Option or Either then the release function will not be called. If you want to make sure that the release function is always called "at the end of the world and whatever happens" you need to call Eff.bracketLast

    Definition Classes
    SafeInterpretation
  14. def bracketLast[R, A, B, C](acquire: Eff[R, A])(use: (A) ⇒ Eff[R, B])(release: (A) ⇒ Eff[R, C]): Eff[R, B]

    Permalink

    bracket an action with one last action to execute at the end of the program

    bracket an action with one last action to execute at the end of the program

    Definition Classes
    EffCreation
  15. def catchThrowable[R, A, B](action: Eff[R, A], pureValue: (A) ⇒ B, onThrowable: (Throwable) ⇒ Eff[R, B])(implicit m: /=[Safe, R]): Eff[R, B]

    Permalink

    evaluate first action possibly having error effects

    evaluate first action possibly having error effects

    Execute a second action if the first one is not successful, based on the error

    Definition Classes
    SafeInterpretation
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def collapse[R, M[_], A](r: Eff[R, M[A]])(implicit m: |=[M, R]): Eff[R, A]

    Permalink

    use the internal effect as one of the stack effects

    use the internal effect as one of the stack effects

    Definition Classes
    EffCreation
  18. def detach[M[_], A](eff: Eff[Fx1[M], A])(implicit monad: Monad[M]): M[A]

    Permalink

    peel-off the only present effect

    peel-off the only present effect

    Definition Classes
    EffInterpretation
  19. def detach[M[_], R, A](eff: Eff[R, A])(implicit monad: Monad[M], m: Aux[M, R, NoFx]): M[A]

    Permalink

    peel-off the only present effect

    peel-off the only present effect

    Definition Classes
    EffInterpretation
  20. def detachA[M[_], A](eff: Eff[Fx1[M], A])(implicit monad: Monad[M], applicative: Applicative[M]): M[A]

    Permalink

    peel-off the only present effect, using an Applicative instance where possible

    peel-off the only present effect, using an Applicative instance where possible

    Definition Classes
    EffInterpretation
  21. def detachA[M[_], R, A](eff: Eff[R, A])(implicit monad: Monad[M], applicative: Applicative[M], member: Aux[M, R, NoFx]): M[A]

    Permalink

    peel-off the only present effect, using an Applicative instance where possible

    peel-off the only present effect, using an Applicative instance where possible

    Definition Classes
    EffInterpretation
  22. final val effApplicativeUnsafe: Applicative[[β$2$]Eff[AnyRef, β$2$]]

    Permalink
    Definition Classes
    EffImplicits
  23. def effInto[R, U, A](e: Eff[R, A])(implicit f: IntoPoly[R, U]): Eff[U, A]

    Permalink

    An Eff[R, A] value can be transformed into an Eff[U, A] value provided that all the effects in R are also in U

    An Eff[R, A] value can be transformed into an Eff[U, A] value provided that all the effects in R are also in U

    Definition Classes
    EffInterpretation
  24. final val effMonadUnsafe: Monad[[β$0$]Eff[AnyRef, β$0$]]

    Permalink

    Monad implementation for the Eff[R, ?] type

    Monad implementation for the Eff[R, ?] type

    Definition Classes
    EffImplicits
  25. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. def exception[R, A](t: Throwable)(implicit arg0: _safe[R]): Eff[R, A]

    Permalink
    Definition Classes
    SafeCreation
  28. def execSafe[R, U, A](r: Eff[R, A])(implicit m: Aux[Safe, R, U]): Eff[U, Either[Throwable, A]]

    Permalink

    run a safe effect but drop the finalizer errors

    run a safe effect but drop the finalizer errors

    Definition Classes
    SafeInterpretation
  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def finalizerException[R](t: Throwable)(implicit arg0: _safe[R]): Eff[R, Unit]

    Permalink
    Definition Classes
    SafeCreation
  31. def flatTraverseA[R, F[_], A, B](fs: F[A])(f: (A) ⇒ Eff[R, F[B]])(implicit FT: Traverse[F], FM: Monad[F]): Eff[R, F[B]]

    Permalink

    use the applicative instance of Eff to traverse a list of values, then flatten it

    use the applicative instance of Eff to traverse a list of values, then flatten it

    Definition Classes
    EffCreation
  32. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  34. def ignoreException[R, E <: Throwable, A](action: Eff[R, A])(implicit arg0: ClassTag[E], m: /=[Safe, R]): Eff[R, Unit]

    Permalink

    ignore one possible exception that could be thrown

    ignore one possible exception that could be thrown

    Definition Classes
    SafeInterpretation
  35. def impure[R, A, B](value: A, continuation: Continuation[R, A, B], map: (B) ⇒ B): Eff[R, B]

    Permalink

    create a delayed impure value

    create a delayed impure value

    Definition Classes
    EffCreation
  36. def impure[R, A, B](value: A, continuation: Continuation[R, A, B]): Eff[R, B]

    Permalink

    create a delayed impure value

    create a delayed impure value

    Definition Classes
    EffCreation
  37. def impure[R, X, A](union: Union[R, X], continuation: Continuation[R, X, A]): Eff[R, A]

    Permalink

    create a impure value from an union of effects and a continuation

    create a impure value from an union of effects and a continuation

    Definition Classes
    EffCreation
  38. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  39. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  40. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  41. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  42. def otherwise[R, A](action: Eff[R, A], onThrowable: Eff[R, A])(implicit m: /=[Safe, R]): Eff[R, A]

    Permalink

    evaluate first action possibly having exceptions

    evaluate first action possibly having exceptions

    Execute a second action if the first one is not successful

    Definition Classes
    SafeInterpretation
  43. def protect[R, A](a: ⇒ A)(implicit arg0: _safe[R]): Eff[R, A]

    Permalink
    Definition Classes
    SafeCreation
  44. def pure[R, A](a: A): Eff[R, A]

    Permalink

    create a pure value

    create a pure value

    Definition Classes
    EffCreation
  45. def recoverThrowable[R, A, B](action: Eff[R, A], pureValue: (A) ⇒ B, onThrowable: PartialFunction[Throwable, Eff[R, B]])(implicit m: /=[Safe, R]): Eff[R, B]

    Permalink

    evaluate first action possibly having error effects

    evaluate first action possibly having error effects

    Execute a second action if the first one is not successful and second is defined for the error

    Definition Classes
    SafeInterpretation
  46. def retryUntil[R, A](e: Eff[R, A], condition: (A) ⇒ Boolean, durations: List[FiniteDuration], waitFor: (FiniteDuration) ⇒ Eff[R, Unit]): Eff[R, A]

    Permalink
    Definition Classes
    EffCreation
  47. def run[A](eff: Eff[NoFx, A]): A

    Permalink

    base runner for an Eff value having no effects at all the execution is trampolined using Eval

    base runner for an Eff value having no effects at all the execution is trampolined using Eval

    Definition Classes
    EffInterpretation
  48. def runPure[R, A](eff: Eff[R, A]): Option[A]

    Permalink

    get the pure value if there is no effect

    get the pure value if there is no effect

    Definition Classes
    EffInterpretation
  49. def runSafe[R, U, A](effect: Eff[R, A])(implicit m: Aux[Safe, R, U]): Eff[U, (Either[Throwable, A], List[Throwable])]

    Permalink

    Run a safe effect

    Run a safe effect

    Collect finalizer exceptions if any

    Definition Classes
    SafeInterpretation
  50. def runWriter[R, U, O, A, B](w: Eff[R, A])(implicit m: Aux[[β$2$]Writer[O, β$2$], R, U]): Eff[U, (A, List[O])]

    Permalink

    run a writer effect and return the list of written values

    run a writer effect and return the list of written values

    This uses a ListBuffer internally to append values

    Definition Classes
    WriterInterpretation
  51. def runWriterFold[R, U, O, A, B](w: Eff[R, A])(fold: RightFold[O, B])(implicit m: Aux[[β$3$]Writer[O, β$3$], R, U]): Eff[U, (A, B)]

    Permalink

    More general fold of runWriter where we can use a fold to accumulate values in a mutable buffer

    More general fold of runWriter where we can use a fold to accumulate values in a mutable buffer

    Definition Classes
    WriterInterpretation
  52. def runWriterIntoMonoid[R, U, O, M, A](w: Eff[R, A])(f: (O) ⇒ M)(implicit m: Aux[[β$8$]Writer[O, β$8$], R, U], M: Monoid[M]): Eff[U, (A, M)]

    Permalink
    Definition Classes
    WriterInterpretation
  53. def runWriterMonoid[R, U, O, A](w: Eff[R, A])(implicit m: Aux[[β$7$]Writer[O, β$7$], R, U], O: Monoid[O]): Eff[U, (A, O)]

    Permalink
    Definition Classes
    WriterInterpretation
  54. def runWriterUnsafe[R, U, O, A](w: Eff[R, A])(f: (O) ⇒ Unit)(implicit m: Aux[[β$5$]Writer[O, β$5$], R, U]): Eff[U, A]

    Permalink

    Run a side-effecting fold

    Run a side-effecting fold

    Definition Classes
    WriterInterpretation
  55. def safeInterpreter[R, A](last: Option[(Eff[R, Unit], /=[Safe, R])]): Interpreter[Safe, R, A, Out[A]]

    Permalink
    Definition Classes
    SafeInterpretation
  56. def safeInterpreter[R, A]: Interpreter[Safe, R, A, Out[A]]

    Permalink
    Definition Classes
    SafeInterpretation
  57. def send[T[_], R, V](tv: T[V])(implicit member: |=[T, R]): Eff[R, V]

    Permalink

    create an Eff[R, A] value from an effectful value of type T[V] provided that T is one of the effects of R

    create an Eff[R, A] value from an effectful value of type T[V] provided that T is one of the effects of R

    Definition Classes
    EffCreation
  58. def sequenceA[R, F[_], A](fs: F[Eff[R, A]])(implicit arg0: Traverse[F]): Eff[R, F[A]]

    Permalink

    use the applicative instance of Eff to sequence a list of values

    use the applicative instance of Eff to sequence a list of values

    Definition Classes
    EffCreation
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  60. def tell[R, O](o: O)(implicit member: |=[[β$0$]Writer[O, β$0$], R]): Eff[R, Unit]

    Permalink

    write a given value

    write a given value

    Definition Classes
    WriterCreation
  61. def thenFinally[R, A](effect: Eff[R, A], last: Eff[R, Unit])(implicit m: /=[Safe, R]): Eff[R, A]

    Permalink

    evaluate first action possibly having error effects execute a second action whether the first is successful or not but keep track of finalizer exceptions

    evaluate first action possibly having error effects execute a second action whether the first is successful or not but keep track of finalizer exceptions

    Definition Classes
    SafeInterpretation
  62. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  63. def traverseA[R, F[_], A, B](fs: F[A])(f: (A) ⇒ Eff[R, B])(implicit arg0: Traverse[F]): Eff[R, F[B]]

    Permalink

    use the applicative instance of Eff to traverse a list of values

    use the applicative instance of Eff to traverse a list of values

    Definition Classes
    EffCreation
  64. def unit[R]: Eff[R, Unit]

    Permalink

    create an Eff value for ()

    create an Eff value for ()

    Definition Classes
    EffCreation
  65. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  67. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  68. def whenFailed[R, A](action: Eff[R, A], onThrowable: (Throwable) ⇒ Eff[R, A])(implicit m: /=[Safe, R]): Eff[R, A]

    Permalink

    evaluate first action possibly throwing exceptions

    evaluate first action possibly throwing exceptions

    Execute a second action if the first one is not successful, based on the exception

    The final value type is the same as the original type

    Definition Classes
    SafeInterpretation
  69. def whenStopped[R, A](e: Eff[R, A], action: Last[R]): Eff[R, A]

    Permalink

    attach a clean-up action to the continuation (if any)

    attach a clean-up action to the continuation (if any)

    Definition Classes
    EffCreation
  70. def whenThrowable[R, A](action: Eff[R, A], onThrowable: PartialFunction[Throwable, Eff[R, A]])(implicit m: /=[Safe, R]): Eff[R, A]

    Permalink

    evaluate first action possibly throwing exceptions

    evaluate first action possibly throwing exceptions

    Execute a second action if the first one is not successful and second is defined for the error

    The final value type is the same as the original type

    Definition Classes
    SafeInterpretation

Inherited from EffImplicits

Inherited from EffCreation

Inherited from EffInterpretation

Inherited from SafeEffect

Inherited from SafeInterpretation

Inherited from SafeCreation

Inherited from SafeTypes

Inherited from WriterEffect

Inherited from WriterInterpretation

Inherited from WriterCreation

Inherited from AnyRef

Inherited from Any

Ungrouped