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
- Alphabetic
- By Inheritance
- Async
- Effect
- Suspendable
- Catchable
- Monad
- Applicative
- Functor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
attempt[A](fa: F[A]): F[Attempt[A]]
Provides access to the error in
fa, if present, by wrapping it in aLeft.Provides access to the error in
fa, if present, by wrapping it in aLeft.- Definition Classes
- Catchable
-
abstract
def
fail[A](err: Throwable): F[A]
Lifts a pure exception in to the error mode of the
Feffect.Lifts a pure exception in to the error mode of the
Feffect.- Definition Classes
- Catchable
-
abstract
def
flatMap[A, B](a: F[A])(f: (A) ⇒ F[B]): F[B]
Computes an
F[B]fromAvalue(s) in anF[A].Computes an
F[B]fromAvalue(s) in anF[A].- Definition Classes
- Monad
-
abstract
def
pure[A](a: A): F[A]
Lifts a pure value in to the
Feffect.Lifts a pure value in to the
Feffect.- Definition Classes
- Applicative
-
abstract
def
ref[A]: F[Ref[F, A]]
Creates an asynchronous, concurrent mutable reference.
-
abstract
def
suspend[A](fa: ⇒ F[A]): F[A]
Returns an
F[A]that evaluates and runs the providedfaon each run.Returns an
F[A]that evaluates and runs the providedfaon each run.- Definition Classes
- Suspendable
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Async[F], B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
ap[A, B](fa: F[A])(f: F[(A) ⇒ B]): F[B]
Converts an
F[A]to anF[B]using an effectful functionF[A => B].Converts an
F[A]to anF[B]using an effectful functionF[A => B].- Definition Classes
- Monad → Applicative
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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. -
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
delay[A](a: ⇒ A): F[A]
Promotes a non-strict value to an
F.Promotes a non-strict value to an
F. Evaluatesaeach time the returned effect is run.- Definition Classes
- Suspendable
- def ensuring(cond: (Async[F]) ⇒ Boolean, msg: ⇒ Any): Async[F]
- def ensuring(cond: (Async[F]) ⇒ Boolean): Async[F]
- def ensuring(cond: Boolean, msg: ⇒ Any): Async[F]
- def ensuring(cond: Boolean): Async[F]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
map[A, B](a: F[A])(f: (A) ⇒ B): F[B]
Converts an
F[A]to anF[B]using a pure functionA => B. -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
parallelSequence[G[_], A](v: G[F[A]])(implicit G: Traverse[G]): F[G[A]]
Like
sequencebut eachF[A]is evaluated in parallel. -
def
parallelTraverse[G[_], A, B](g: G[A])(f: (A) ⇒ F[B])(implicit G: Traverse[G]): F[G[B]]
Like
traversebut eachF[B]computed from anAis evaluated in parallel. -
def
refOf[A](a: A): F[Ref[F, A]]
Creates an asynchronous, concurrent mutable reference, initialized to
a. -
def
start[A](f: F[A]): F[F[A]]
Begins asynchronous evaluation of
fwhen the returnedF[F[A]]is bound.Begins asynchronous evaluation of
fwhen the returnedF[F[A]]is bound. The innerF[A]will block until the result is available. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (Async[F], B)