Packages

trait Async[F[_]] extends Effect[F]

Type class which describes effects that support asynchronous evaluation.

Instances of this type class are defined by providing an implementation of ref, which allocates a mutable memory cell that supports various asynchronous operations.

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

Self Type
Async[F]
Annotations
@implicitNotFound( ... )
Source
Async.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Async
  2. Effect
  3. Suspendable
  4. Catchable
  5. Monad
  6. Applicative
  7. Functor
  8. AnyRef
  9. 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]]

    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]

    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]

    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]

    Lifts a pure value in to the F effect.

    Lifts a pure value in to the F effect.

    Definition Classes
    Applicative
  5. abstract def ref[A]: F[Ref[F, A]]

    Creates an asynchronous, concurrent mutable reference.

  6. abstract def suspend[A](fa: ⇒ F[A]): F[A]

    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
  7. abstract def unsafeRunAsync[A](fa: F[A])(cb: (Attempt[A]) ⇒ Unit): Unit

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

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

    Definition Classes
    Effect

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Async[F] to any2stringadd[Async[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Async[F], B)
    Implicit
    This member is added by an implicit conversion from Async[F] to ArrowAssoc[Async[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def ap[A, B](fa: F[A])(f: F[(A) ⇒ B]): F[B]

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

    Definition Classes
    MonadApplicative
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def async[A](register: ((Either[Throwable, A]) ⇒ Unit) ⇒ F[Unit]): F[A]

    Creates an F[A] from an asynchronous computation, which takes the form of a function with which we can register a callback.

    Creates an F[A] from an asynchronous computation, which takes the form of a function with which we can register a callback. This can be used to translate from a callback-based API to a straightforward monadic version.

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

    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
  11. def ensuring(cond: (Async[F]) ⇒ Boolean, msg: ⇒ Any): Async[F]
    Implicit
    This member is added by an implicit conversion from Async[F] to Ensuring[Async[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Async[F]) ⇒ Boolean): Async[F]
    Implicit
    This member is added by an implicit conversion from Async[F] to Ensuring[Async[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Async[F]
    Implicit
    This member is added by an implicit conversion from Async[F] to Ensuring[Async[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Async[F]
    Implicit
    This member is added by an implicit conversion from Async[F] to Ensuring[Async[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Async[F] to StringFormat[Async[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def map[A, B](a: F[A])(f: (A) ⇒ B): F[B]

    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
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  26. def parallelSequence[G[_], A](v: G[F[A]])(implicit G: Traverse[G]): F[G[A]]

    Like sequence but each F[A] is evaluated in parallel.

  27. def parallelTraverse[G[_], A, B](g: G[A])(f: (A) ⇒ F[B])(implicit G: Traverse[G]): F[G[B]]

    Like traverse but each F[B] computed from an A is evaluated in parallel.

  28. def refOf[A](a: A): F[Ref[F, A]]

    Creates an asynchronous, concurrent mutable reference, initialized to a.

  29. def start[A](f: F[A]): F[F[A]]

    Begins asynchronous evaluation of f when the returned F[F[A]] is bound.

    Begins asynchronous evaluation of f when the returned F[F[A]] is bound. The inner F[A] will block until the result is available.

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (Async[F], B)
    Implicit
    This member is added by an implicit conversion from Async[F] to ArrowAssoc[Async[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Effect[F]

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 Async[F] to any2stringadd[Async[F]]

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

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

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

Ungrouped