Trait/Object

fs2

Async

Related Docs: object Async | package fs2

Permalink

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

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

Type Members

  1. abstract type Ref[A]

    Permalink

Abstract Value Members

  1. abstract def access[A](r: Ref[A]): F[(A, (Either[Throwable, A]) ⇒ F[Boolean])]

    Permalink

    Obtain a snapshot of the current value of the Ref, and a setter for updating the value.

    Obtain a snapshot of the current value of the Ref, and a setter for updating the value. The setter may noop (in which case false is returned) if another concurrent call to access uses its setter first. Once it has noop'd or been used once, a setter never succeeds again.

  2. abstract def attempt[A](fa: F[A]): F[Either[Throwable, A]]

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

    Permalink
    Definition Classes
    Monad
  4. abstract def cancellableGet[A](r: Ref[A]): F[(F[A], F[Unit])]

    Permalink

    Like get, but returns an F[Unit] that can be used cancel the subscription.

  5. abstract def fail[A](err: Throwable): F[A]

    Permalink
    Definition Classes
    Catchable
  6. abstract def pure[A](a: A): F[A]

    Permalink
    Definition Classes
    Monad
  7. abstract def ref[A]: F[Ref[A]]

    Permalink

    Create an asynchronous, concurrent mutable reference.

  8. abstract def set[A](r: Ref[A])(a: F[A]): F[Unit]

    Permalink

    Asynchronously set a reference.

    Asynchronously set a reference. After the returned F[Unit] is bound, the task is running in the background. Multiple tasks may be added to a Ref[A].

    Satisfies: set(r)(t) flatMap { _ => get(r) } == t.

  9. abstract def setFree[A](r: Ref[A])(a: Free[F, A]): F[Unit]

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

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 Async[F] to any2stringadd[Async[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Async[F], B)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def async[A](register: ((Either[Throwable, A]) ⇒ Unit) ⇒ F[Unit]): F[A]

    Permalink

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

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

  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, catching exceptions in the process.

    Promotes a non-strict value to an F, catching exceptions in the process. Evaluates a each time the returned effect is run.

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

    Permalink
    Implicit information
    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
  11. def ensuring(cond: (Async[F]) ⇒ Boolean): Async[F]

    Permalink
    Implicit information
    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: Boolean, msg: ⇒ Any): Async[F]

    Permalink
    Implicit information
    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): Async[F]

    Permalink
    Implicit information
    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. 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 Async[F] to StringFormat[Async[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. def get[A](r: Ref[A]): F[A]

    Permalink

    Obtain the value of the Ref, or wait until it has been set.

  19. final def getClass(): Class[_]

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

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

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

    Permalink
    Definition Classes
    MonadFunctor
  23. def modify[A](r: Ref[A])(f: (A) ⇒ A): F[Change[A]]

    Permalink

    Repeatedly invoke tryModify(f) until it succeeds.

  24. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. def parallelTraverse[A, B](s: Seq[A])(f: (A) ⇒ F[B]): F[Vector[B]]

    Permalink
  28. def read[A](r: Ref[A]): Future[F, A]

    Permalink

    The read-only portion of a Ref.

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

    Permalink

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

  30. def setPure[A](r: Ref[A])(a: A): F[Unit]

    Permalink
  31. def start[A](f: F[A]): F[F[A]]

    Permalink

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

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

  32. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  34. def traverse[A, B](v: Seq[A])(f: (A) ⇒ F[B]): F[Vector[B]]

    Permalink
    Definition Classes
    Monad
  35. def tryModify[A](r: Ref[A])(f: (A) ⇒ A): F[Option[Change[A]]]

    Permalink

    Try modifying the reference once, returning None if another concurrent set or modify completes between the time the variable is read and the time it is set.

  36. final def wait(): Unit

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

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

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

    Permalink
    Implicit information
    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 Catchable[F]

Inherited from Monad[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