Class/Object

zio

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.

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. val get: UIO[A]

    Permalink

    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.

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

    Permalink

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

  11. def getAndUpdate(f: (A) ⇒ A): UIO[A]

    Permalink

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

  12. def getAndUpdateSome(pf: PartialFunction[A, A]): UIO[A]

    Permalink

    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.

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  16. def locally[R, E, B](value: A)(use: ZIO[R, E, B]): ZIO[R, E, B]

    Permalink

    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.

  17. def modify[B](f: (A) ⇒ (B, A)): UIO[B]

    Permalink

    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.

  18. def modifySome[B](default: B)(pf: PartialFunction[A, (B, A)]): UIO[B]

    Permalink

    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.

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. def set(value: A): UIO[Unit]

    Permalink

    Sets the value associated with the current fiber.

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

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. def unsafeAsThreadLocal: UIO[ThreadLocal[A]]

    Permalink

    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.

  26. def update(f: (A) ⇒ A): UIO[Unit]

    Permalink

    Atomically modifies the FiberRef with the specified function.

  27. def updateAndGet(f: (A) ⇒ A): UIO[A]

    Permalink

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

  28. def updateLocally[R, E, B](f: (A) ⇒ A)(use: ZIO[R, E, B]): ZIO[R, E, B]

    Permalink

    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.

  29. def updateSome(pf: PartialFunction[A, A]): UIO[Unit]

    Permalink

    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.

  30. def updateSomeAndGet(pf: PartialFunction[A, A]): UIO[A]

    Permalink

    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.

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

    Permalink

    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.

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped