Class

fs2.Task

Ref

Related Doc: package Task

Permalink

class Ref[A] extends util.Async.Ref[Task, A]

Source
Task.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ref
  2. Ref
  3. AnyRef
  4. 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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. implicit val F: Async[Task]

    Permalink
    Attributes
    protected
    Definition Classes
    RefRef
  7. def access: Task[(A, (Attempt[A]) ⇒ Task[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.

    Definition Classes
    RefRef
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def cancellableGet: Task[(Task[A], Task[Unit])]

    Permalink

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

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

    Definition Classes
    RefRef
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (Ref[A]) ⇒ Boolean, msg: ⇒ Any): Ref[A]

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

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

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

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from Ref[A] to StringFormat[Ref[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. def get: Task[A]

    Permalink

    Return the most recently completed set, or block until a set value is available.

    Return the most recently completed set, or block until a set value is available.

    Definition Classes
    RefRef
  20. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  23. def modify(f: (A) ⇒ A): Task[Change[A]]

    Permalink

    Repeatedly invoke tryModify(f) until it succeeds.

    Repeatedly invoke tryModify(f) until it succeeds.

    Definition Classes
    Ref
  24. def modify2[B](f: (A) ⇒ (A, B)): Task[(Change[A], B)]

    Permalink

    Like modify, but allows to extra b in single step.

    Like modify, but allows to extra b in single step. *

    Definition Classes
    Ref
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  28. def set(t: Task[A]): Task[Unit]

    Permalink

    Return a Task that submits t to this ref for evaluation.

    Return a Task that submits t to this ref for evaluation. When it completes it overwrites any previously put value.

    Definition Classes
    RefRef
  29. def setPure(a: A): Task[Unit]

    Permalink

    Asynchronously set a reference to a pure value.

    Asynchronously set a reference to a pure value.

    Satisfies: r.setPure(a) flatMap { _ => r.get(a) } == pure(a).

    Definition Classes
    Ref
  30. def setRace(t1: Task[A], t2: Task[A]): Task[Unit]

    Permalink

    Runs t1 and t2 simultaneously, but only the winner gets to set to this ref.

    Runs t1 and t2 simultaneously, but only the winner gets to set to this ref. The loser continues running but its reference to this ref is severed, allowing this ref to be garbage collected if it is no longer referenced by anyone other than the loser.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  33. def tryModify(f: (A) ⇒ A): Task[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.

    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.

    Definition Classes
    Ref
  34. def tryModify2[B](f: (A) ⇒ (A, B)): Task[Option[(Change[A], B)]]

    Permalink

    Like tryModify but allows to return B along with change.

    Like tryModify but allows to return B along with change. *

    Definition Classes
    Ref
  35. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def [B](y: B): (Ref[A], B)

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

Inherited from util.Async.Ref[Task, A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Ref[A] to any2stringadd[Ref[A]]

Inherited by implicit conversion StringFormat from Ref[A] to StringFormat[Ref[A]]

Inherited by implicit conversion Ensuring from Ref[A] to Ensuring[Ref[A]]

Inherited by implicit conversion ArrowAssoc from Ref[A] to ArrowAssoc[Ref[A]]

Ungrouped