final class RefM[A] extends Serializable
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.unit *> IO.succeed(3)) _ <- putStrLn("Value = " + v) // Value = 5 } yield ()
- Alphabetic
- By Inheritance
- RefM
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
get: UIO[A]
Reads the value from the
Ref
.Reads the value from the
Ref
.- returns
UIO[A]
value from theRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
modify[R, E, B](f: (A) ⇒ ZIO[R, E, (B, A)]): ZIO[R, E, 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 ofupdate
.- R
environment of the effect
- E
error type
- B
type of the
RefM
- f
function which computes a return value for the modification
- returns
ZIO[R, E, B]
modified value of theRefM
-
final
def
modifySome[R, E, B](default: B)(pf: PartialFunction[A, ZIO[R, E, (B, A)]]): ZIO[R, E, 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 ofupdateSome
.- R
environment of the effect
- E
error type
- B
type of the
RefM
- default
default value to be returned if the partial function is not defined on the current value
- pf
partial function to be computed on the current value if defined on the current value
- returns
ZIO[R, E, B]
modified value of theRefM
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
set(a: A): UIO[Unit]
Writes a new value to the
Ref
, with a guarantee of immediate consistency (at some cost to performance).Writes a new value to the
Ref
, with a guarantee of immediate consistency (at some cost to performance).- a
value to be written to the
RefM
- returns
UIO[Unit]
-
final
def
setAsync(a: A): UIO[Unit]
Writes a new value to the
Ref
without providing a guarantee of immediate consistency.Writes a new value to the
Ref
without providing a guarantee of immediate consistency.- a
value to be written to the
RefM
- returns
UIO[Unit]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
update[R, E](f: (A) ⇒ ZIO[R, E, A]): ZIO[R, E, A]
Atomically modifies the
RefM
with the specified function, returning the value immediately after modification.Atomically modifies the
RefM
with the specified function, returning the value immediately after modification.- R
environment of the effect
- E
error type
- f
function to atomically modify the
RefM
- returns
ZIO[R, E, A]
modified value of theRefM
-
final
def
updateSome[R, E](pf: PartialFunction[A, ZIO[R, E, A]]): ZIO[R, E, 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.- R
environment of the effect
- E
error type
- pf
partial function to atomically modify the
RefM
- returns
ZIO[R, E, A]
modified value of theRefM
-
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( ... ) @native()