Class/Object

FiberRef

Related Docs: object FiberRef | package zio

Permalink

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.

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

FiberRef
Serializable
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new FiberRef(initial: A)

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 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.
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 locally[R, E, B](value: A)(use: ZIO[R, E, B]): ZIO[R, E, B]

Returns an IO that runs with value bound to the current fiber.
Returns an IO that runs with value bound to the current fiber.
Guarantees that fiber data is properly restored via bracket.
final 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 of update.
final 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 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(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
final def update(f: (A) ⇒ A): UIO[A]

Atomically modifies the FiberRef with the specified function.
final def updateSome(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 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( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped