Trait/Object

fs2.util

Effect

Related Docs: object Effect | package util

Permalink

trait Effect[F[_]] extends Catchable[F] with Suspendable[F]

Monad which supports catching exceptions, suspending evaluation, and (potentially asynchronous) evaluation (i.e. extraction of a value).

For infix syntax, import fs2.util.syntax._.

Source
Effect.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Effect
  2. Suspendable
  3. Catchable
  4. Monad
  5. Applicative
  6. Functor
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def attempt[A](fa: F[A]): F[Attempt[A]]

    Permalink

    Provides access to the error in fa, if present, by wrapping it in a Left.

    Provides access to the error in fa, if present, by wrapping it in a Left.

    Definition Classes
    Catchable
  2. abstract def fail[A](err: Throwable): F[A]

    Permalink

    Lifts a pure exception in to the error mode of the F effect.

    Lifts a pure exception in to the error mode of the F effect.

    Definition Classes
    Catchable
  3. abstract def flatMap[A, B](a: F[A])(f: (A) ⇒ F[B]): F[B]

    Permalink

    Computes an F[B] from A value(s) in an F[A].

    Computes an F[B] from A value(s) in an F[A].

    Definition Classes
    Monad
  4. abstract def pure[A](a: A): F[A]

    Permalink

    Lifts a pure value in to the F effect.

    Lifts a pure value in to the F effect.

    Definition Classes
    Applicative
  5. abstract def suspend[A](fa: ⇒ F[A]): F[A]

    Permalink

    Returns an F[A] that evaluates and runs the provided fa on each run.

    Returns an F[A] that evaluates and runs the provided fa on each run.

    Definition Classes
    Suspendable
  6. abstract def unsafeRunAsync[A](fa: F[A])(cb: (Attempt[A]) ⇒ Unit): Unit

    Permalink

    Evaluates the specified F[A], possibly asynchronously, and calls the specified callback with the result of the evaluation.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to any2stringadd[Effect[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Effect[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to ArrowAssoc[Effect[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def ap[A, B](fa: F[A])(f: F[(A) ⇒ B]): F[B]

    Permalink

    Converts an F[A] to an F[B] using an effectful function F[A => B].

    Converts an F[A] to an F[B] using an effectful function F[A => B]. The function effect is evaluated first, followed by the F[A] effect.

    Definition Classes
    MonadApplicative
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def delay[A](a: ⇒ A): F[A]

    Permalink

    Promotes a non-strict value to an F.

    Promotes a non-strict value to an F. Evaluates a each time the returned effect is run.

    Definition Classes
    Suspendable
  10. def ensuring(cond: (Effect[F]) ⇒ Boolean, msg: ⇒ Any): Effect[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Effect[F]) ⇒ Boolean): Effect[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): Effect[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Effect[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to StringFormat[Effect[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def map[A, B](a: F[A])(f: (A) ⇒ B): F[B]

    Permalink

    Converts an F[A] to an F[B] using a pure function A => B.

    Converts an F[A] to an F[B] using a pure function A => B.

    Definition Classes
    MonadFunctor
  22. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  25. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (Effect[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Effect[F] to ArrowAssoc[Effect[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Suspendable[F]

Inherited from Catchable[F]

Inherited from Monad[F]

Inherited from Applicative[F]

Inherited from Functor[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Effect[F] to any2stringadd[Effect[F]]

Inherited by implicit conversion StringFormat from Effect[F] to StringFormat[Effect[F]]

Inherited by implicit conversion Ensuring from Effect[F] to Ensuring[Effect[F]]

Inherited by implicit conversion ArrowAssoc from Effect[F] to ArrowAssoc[Effect[F]]

Ungrouped