Packages

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]
Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FiberRef
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. 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.

  9. def getAndSet(a: A): UIO[A]

    Atomically sets the value associated with the current fiber and returns the old value.

  10. def getAndUpdate(f: (A) => A): UIO[A]

    Atomically modifies the FiberRef with the specified function and returns the old value.

  11. 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.

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. 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.

  16. 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.

  17. 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.

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def set(value: A): UIO[Unit]

    Sets the value associated with the current fiber.

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def unsafeAsThreadLocal: UIO[ThreadLocal[A]]

    Returns a ThreadLocal that can be used to interact with this FiberRef from side effecting code.

    Returns a ThreadLocal that can be used to interact with this FiberRef 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 this FiberRef on all threads that are currently managed by ZIO, and behave like an ordinary ThreadLocal on all other threads.

  25. def update(f: (A) => A): UIO[Unit]

    Atomically modifies the FiberRef with the specified function.

  26. def updateAndGet(f: (A) => A): UIO[A]

    Atomically modifies the FiberRef with the specified function and returns the result.

  27. def updateLocally[R, E, B](f: (A) => A)(use: ZIO[R, E, B]): ZIO[R, E, B]

    Returns an IO that runs with result of calling the specified function bound to the current fiber.

    Returns an IO that runs with result of calling the specified function bound to the current fiber.

    Guarantees that fiber data is properly restored via bracket.

  28. 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.

  29. 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.

  30. def updateSomeLocally[R, E, B](pf: PartialFunction[A, A])(use: ZIO[R, E, B]): ZIO[R, E, B]

    Returns an IO that runs with result of calling the specified partial function bound to the current fiber.

    Returns an IO that runs with result of calling the specified partial function bound to the current fiber.

    Guarantees that fiber data is properly restored via bracket.

  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()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped