final class FiberRef[A] extends Serializable
Fiber's counterpart for Java's ThreadLocal
. Value is automatically propagated
to child on fork and merged back in after joining child.
for { fiberRef <- FiberRef.make("Hello world!") child <- fiberRef.set("Hi!).fork result <- child.join } yield result
result
will be equal to "Hi!" as changes done by child were merged on join.
FiberRef#make also allows specifying how the values will be combined when joining. By default this will use the value of the joined fiber. for { fiberRef <- FiberRef.make(0, math.max) child <- fiberRef.update(_ + 1).fork _ <- fiberRef.update(_ + 2) _ <- child.join value <- fiberRef.get } yield value }}}
value
will be 2 as the value in the joined fiber is lower and we specified max
as our combine function.
- Self Type
- FiberRef[A]
- Alphabetic
- By Inheritance
- FiberRef
- 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] )
-
val
get: UIO[A]
Reads the value associated with the current fiber.
Reads the value associated with the current fiber. Returns initial value if no value was
set
or inherited from parent. -
def
getAndSet(a: A): UIO[A]
Atomically sets the value associated with the current fiber and returns the old value.
-
def
getAndUpdate(f: (A) ⇒ A): UIO[A]
Atomically modifies the
FiberRef
with the specified function and returns the old value. -
def
getAndUpdateSome(pf: PartialFunction[A, A]): UIO[A]
Atomically modifies the
FiberRef
with the specified partial function and returns the old value.Atomically modifies the
FiberRef
with the specified partial function and returns the old value. If the function is undefined on the current value it doesn't change it. -
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
-
def
locally[R, E, B](value: A)(use: ZIO[R, E, B]): ZIO[R, E, B]
Returns an
IO
that runs withvalue
bound to the current fiber.Returns an
IO
that runs withvalue
bound to the current fiber.Guarantees that fiber data is properly restored via
bracket
. -
def
modify[B](f: (A) ⇒ (B, A)): UIO[B]
Atomically modifies the
FiberRef
with the specified function, which computes a return value for the modification.Atomically modifies the
FiberRef
with the specified function, which computes a return value for the modification. This is a more powerful version ofupdate
. -
def
modifySome[B](default: B)(pf: PartialFunction[A, (B, A)]): UIO[B]
Atomically modifies the
FiberRef
with the specified partial 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
FiberRef
with the specified partial 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
. -
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()
-
def
set(value: A): UIO[Unit]
Sets the value associated with the current fiber.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unsafeAsThreadLocal: UIO[ThreadLocal[A]]
Returns a
ThreadLocal
that can be used to interact with thisFiberRef
from side effecting code.Returns a
ThreadLocal
that can be used to interact with thisFiberRef
from side effecting code.This feature is meant to be used for integration with side effecting code, that needs to access fiber specific data, like MDC contexts and the like. The returned
ThreadLocal
will be backed by thisFiberRef
on all threads that are currently managed by ZIO, and behave like an ordinaryThreadLocal
on all other threads. -
def
update(f: (A) ⇒ A): UIO[Unit]
Atomically modifies the
FiberRef
with the specified function. -
def
updateAndGet(f: (A) ⇒ A): UIO[A]
Atomically modifies the
FiberRef
with the specified function and returns the result. -
def
updateSome(pf: PartialFunction[A, A]): UIO[Unit]
Atomically modifies the
FiberRef
with the specified partial function.Atomically modifies the
FiberRef
with the specified partial function. If the function is undefined on the current value it doesn't change it. -
def
updateSomeAndGet(pf: PartialFunction[A, A]): UIO[A]
Atomically modifies the
FiberRef
with the specified partial function.Atomically modifies the
FiberRef
with the specified partial function. If the function is undefined on 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( ... ) @native()