Packages

abstract class Ref[A] extends Serializable

A Ref is a purely functional description of a mutable reference. The fundamental operations of a Ref are set and get. set sets the reference to a new value. get gets the current value of the reference.

By default, Ref is implemented in terms of compare and swap operations for maximum performance and does not support performing effects within update operations. If you need to perform effects within update operations you can create a Ref.Synchronized, a specialized type of Ref that supports performing effects within update operations at some cost to performance. In this case writes will semantically block other writers, while multiple readers can read simultaneously.

NOTE: While Ref provides the functional equivalent of a mutable reference, the value inside the Ref should normally be immutable since compare and swap operations are not safe for mutable values that do not support concurrent access. If you do need to use a mutable value Ref.Synchronized will guarantee that access to the value is properly synchronized.

Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
Synchronized, SubscriptionRef
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ref
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Ref()

Abstract Value Members

  1. abstract def get(implicit trace: Trace): UIO[A]

    Reads the value from the Ref.

  2. abstract def modify[B](f: (A) => (B, A))(implicit trace: Trace): UIO[B]

    Atomically modifies the Ref with the specified function, which computes a return value for the modification.

    Atomically modifies the Ref with the specified function, which computes a return value for the modification. This is a more powerful version of update.

  3. abstract def set(a: A)(implicit trace: Trace): UIO[Unit]

    Writes a new value to the Ref, with a guarantee of immediate consistency (at some cost to performance).

  4. abstract def setAsync(a: A)(implicit trace: Trace): UIO[Unit]

    Writes a new value to the Ref without providing a guarantee of immediate consistency.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def addAndGet(delta: A)(implicit num: Numeric[A], trace: Trace): UIO[A]

    Atomically adds delta to the current value of the Ref and returns the updated value.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def decrementAndGet(implicit num: Numeric[A], trace: Trace): UIO[A]

    Atomically decrements the current value of the Ref by 1 and returns the updated value.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getAndAdd(delta: A)(implicit num: Numeric[A], trace: Trace): UIO[A]

    Atomically adds delta to the current value of the Ref, returning the value immediately before modification.

  11. final def getAndDecrement(implicit num: Numeric[A], trace: Trace): UIO[A]

    Atomically decrements the current value of the Ref by 1, returning the value immediately before modification.

  12. final def getAndIncrement(implicit num: Numeric[A], trace: Trace): UIO[A]

    Atomically increments the current value of the Ref by 1, returning the value immediately before modification.

  13. def getAndSet(a: A)(implicit trace: Trace): UIO[A]

    Atomically writes the specified value to the Ref, returning the value immediately before modification.

  14. def getAndUpdate(f: (A) => A)(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified function, returning the value immediately before modification.

  15. def getAndUpdateSome(pf: PartialFunction[A, A])(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified partial function, returning the value immediately before modification.

    Atomically modifies the Ref with the specified partial function, returning the value immediately before modification. If the function is undefined on the current value it doesn't change it.

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def incrementAndGet(implicit num: Numeric[A], trace: Trace): UIO[A]

    Atomically increments the current value of the Ref by 1 and returns the updated value.

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def modifySome[B](default: B)(pf: PartialFunction[A, (B, A)])(implicit trace: Trace): UIO[B]

    Atomically modifies the Ref with the specified partial function, which computes a return value for the modification if the function is defined on the current value otherwise it returns a default value.

    Atomically modifies the Ref with the specified partial function, which computes a return value for the modification if the function is defined on the current value otherwise it returns a default value. This is a more powerful version of updateSome.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def update(f: (A) => A)(implicit trace: Trace): UIO[Unit]

    Atomically modifies the Ref with the specified function.

  27. def updateAndGet(f: (A) => A)(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified function and returns the updated value.

  28. def updateSome(pf: PartialFunction[A, A])(implicit trace: Trace): UIO[Unit]

    Atomically modifies the Ref with the specified partial function.

    Atomically modifies the Ref with the specified partial function. If the function is undefined on the current value it doesn't change it.

  29. def updateSomeAndGet(pf: PartialFunction[A, A])(implicit trace: Trace): UIO[A]

    Atomically modifies the Ref with the specified partial function.

    Atomically modifies the Ref with the specified partial function. If the function is undefined on the current value it returns the old value without changing it.

  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped