RefM

A mutable atomic reference for the IO monad. This is the IO equivalent of a volatile var, augmented with atomic effectful operations, which make it useful as a reasonably efficient (if low-level) concurrency primitive.

Unlike Ref, RefM allows effects in atomic operations, which makes the structure slower but more powerful than Ref.

for {
  ref <- RefM(2)
  v   <- ref.update(_ + putStrLn("Hello World!").attempt.void *> IO.succeed(3))
  _   <- putStrLn("Value = " + v) // Value = 5
} yield ()

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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] )
final def get: IO[Nothing, A]

Reads the value from the Ref.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def modify[B](f: (A) ⇒ IO[Nothing, (B, A)]): IO[Nothing, B]

Atomically modifies the RefM with the specified function, which computes a return value for the modification.
Atomically modifies the RefM with the specified function, which computes a return value for the modification. This is a more powerful version of update.
final def modifySome[B](default: B)(pf: PartialFunction[A, IO[Nothing, (B, A)]]): IO[Nothing, B]

Atomically modifies the RefM with the specified function, which computes a return value for the modification if the function is defined in the current value otherwise it returns a default value.
Atomically modifies the RefM with the specified function, which computes a return value for the modification if the function is defined in the current value otherwise it returns a default value. This is a more powerful version of updateSome.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def set(a: A): IO[Nothing, Unit]

Writes a new value to the Ref, with a guarantee of immediate consistency (at some cost to performance).
final def setAsync(a: A): IO[Nothing, Unit]

Writes a new value to the Ref without providing a guarantee of immediate consistency.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def update(f: (A) ⇒ IO[Nothing, A]): IO[Nothing, A]

Atomically modifies the RefM with the specified function, returning the value immediately after modification.
final def updateSome(pf: PartialFunction[A, IO[Nothing, A]]): IO[Nothing, A]

Atomically modifies the RefM with the specified partial function.
Atomically modifies the RefM with the specified partial function. if the function is undefined in the current value it returns the old value without changing it.
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( ... )

Related Docs: object RefM | package zio

final class RefM[A] extends Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def get: IO[Nothing, A]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def modify[B](f: (A) ⇒ IO[Nothing, (B, A)]): IO[Nothing, B]

final def modifySome[B](default: B)(pf: PartialFunction[A, IO[Nothing, (B, A)]]): IO[Nothing, B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def set(a: A): IO[Nothing, Unit]

final def setAsync(a: A): IO[Nothing, Unit]

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

def toString(): String

final def update(f: (A) ⇒ IO[Nothing, A]): IO[Nothing, A]

final def updateSome(pf: PartialFunction[A, IO[Nothing, A]]): IO[Nothing, A]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped