Trait/Object

zio

FiberRef

Related Docs: object FiberRef | package zio

Permalink

trait FiberRef[A] extends Serializable

A FiberRef is ZIO's equivalent of Java's ThreadLocal. The value of a FiberRef is automatically propagated to child fibers when they are forked and merged back in to the value of the parent fiber after they are joined.

for {
  fiberRef <- FiberRef.make("Hello world!")
  child    <- fiberRef.set("Hi!).fork
  result   <- child.join
} yield result

Here result will be equal to "Hi!" since changed made by a child fiber are merged back in to the value of the parent fiber on join.

By default the value of the child fiber will replace the value of the parent fiber on join but you can specify your own logic for how values should be merged.

for {
  fiberRef <- FiberRef.make(0, math.max)
  child    <- fiberRef.update(_ + 1).fork
  _        <- fiberRef.update(_ + 2)
  _        <- child.join
  value    <- fiberRef.get
} yield value

Here value will be 2 as the value in the joined fiber is lower and we specified max as our combining function.

Self Type
FiberRef[A]
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Proxy, TrackingFiberRef
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

Type Members

  1. abstract type Patch

    Permalink

    The type of the patch that describes updates to the value of the FiberRef.

    The type of the patch that describes updates to the value of the FiberRef. In the simple case this will just be a function that sets the value of the FiberRef. In more complex cases this will describe an update to a piece of a whole value, allowing updates to the value by different fibers to be combined in a compositional way when those fibers are joined.

  2. type Value = A

    Permalink

    The type of the value of the FiberRef.

Abstract Value Members

  1. abstract def combine(first: Patch, second: Patch): Patch

    Permalink

    Combines two patches to produce a new patch that describes the updates of the first patch and then the updates of the second patch.

    Combines two patches to produce a new patch that describes the updates of the first patch and then the updates of the second patch. The combine operation should be associative. In addition, if the combine operation is commutative then joining multiple fibers concurrently will result in deterministic FiberRef values.

  2. abstract def diff(oldValue: Value, newValue: Value): Patch

    Permalink

    Constructs a patch describing the updates to a value from an old value and a new value.

  3. abstract def fork: Patch

    Permalink

    The initial patch that is applied to the value of the FiberRef when a new fiber is forked.

  4. abstract def initial: Value

    Permalink

    The initial value of the FiberRef.

  5. abstract def join(oldValue: Value, newValue: Value): Value

    Permalink

  6. abstract def patch(patch: Patch)(oldValue: Value): Value

    Permalink

    Applies a patch to an old value to produce a new value that is equal to the old value with the updates described by the patch.

Concrete 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 asThreadLocal(implicit trace: Trace, unsafe: Unsafe): 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 when this feature is enabled using Runtime.enableCurrentFiber, and behave like an ordinary ThreadLocal on all other threads.

  6. def clone(): AnyRef

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

  7. def delete(implicit trace: Trace): UIO[Unit]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

  11. def get(implicit trace: Trace): 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.

  12. final def getAndSet(newValue: A)(implicit trace: Trace): UIO[A]

    Permalink

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

  13. final def getAndUpdate(f: (A) ⇒ A)(implicit trace: Trace): UIO[A]

    Permalink

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

  14. final def getAndUpdateSome(pf: PartialFunction[A, A])(implicit trace: Trace): 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.

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

    Permalink
    Definition Classes
    AnyRef → Any

  16. def getWith[R, E, B](f: (A) ⇒ ZIO[R, E, B])(implicit trace: Trace): ZIO[R, E, B]

    Permalink

    Gets the value associated with the current fiber and uses it to run the specified effect.

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. def locally[R, E, B](newValue: A)(zio: ZIO[R, E, B])(implicit trace: Trace): ZIO[R, E, B]

    Permalink

    Returns a ZIO that runs with value bound to the current fiber.

    Returns a ZIO that runs with value bound to the current fiber.

    Guarantees that fiber data is properly restored via acquireRelease.

  20. final def locallyScoped(value: A)(implicit trace: Trace): ZIO[Scope, Nothing, Unit]

    Permalink

    Returns a scoped workflow that sets the value associated with the curent fiber to the specified value and restores it to its original value when the scope is closed.

  21. final def locallyScopedWith(f: (A) ⇒ A)(implicit trace: Trace): ZIO[Scope, Nothing, Unit]

    Permalink

    Returns a scoped workflow that updates the value associated with the current fiber using the specified function and restores it to its original value when the scope is closed.

  22. final def locallyWith[R, E, B](f: (A) ⇒ A)(zio: ZIO[R, E, B])(implicit trace: Trace): ZIO[R, E, B]

    Permalink

    Returns a ZIO that runs with f applied to the current fiber.

    Returns a ZIO that runs with f applied to the current fiber.

    Guarantees that fiber data is properly restored via acquireRelease.

  23. def modify[B](f: (A) ⇒ (B, A))(implicit trace: Trace): 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.

  24. final def modifySome[B](default: B)(pf: PartialFunction[A, (B, A)])(implicit trace: Trace): 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.

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

    Permalink
    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. final def reset(implicit trace: Trace): UIO[Unit]

    Permalink

  29. def set(value: A)(implicit trace: Trace): UIO[Unit]

    Permalink

    Sets the value associated with the current fiber.

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

    Permalink
    Definition Classes
    AnyRef

  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  32. def update(f: (A) ⇒ A)(implicit trace: Trace): UIO[Unit]

    Permalink

    Atomically modifies the FiberRef with the specified function.

  33. final def updateAndGet(f: (A) ⇒ A)(implicit trace: Trace): UIO[A]

    Permalink

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

  34. final def updateSome(pf: PartialFunction[A, A])(implicit trace: Trace): 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.

  35. final def updateSomeAndGet(pf: PartialFunction[A, A])(implicit trace: Trace): 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.

  36. final def wait(): Unit

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

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

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

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