Packages

sealed abstract class ZRef[-RA, -RB, +EA, +EB, -A, +B] extends Serializable

A ZRef[RA, RB, EA, EB, A, B] is a polymorphic, purely functional description of a mutable reference. The fundamental operations of a ZRef are set and get. set takes a value of type A and sets the reference to a new value, requiring an environment of type RA and potentially failing with an error of type EA. get gets the current value of the reference and returns a value of type B, requiring an environment of type RB and potentially failing with an error of type EB.

When the error and value types of the ZRef are unified, that is, it is a ZRef[R, R, E, E, A, A], the ZRef also supports atomic modify and update operations. All operations are guaranteed to be safe for concurrent access.

By default, ZRef is implemented in terms of compare and swap operations for maximum performance and does not support performing effects within update operations. If you need to perform effects within update operations you can create a ZRef.Synchronized, a specialized type of ZRef that supports performing effects within update operations at some cost to performance. In this case writes will semantically block other writers, while multiple readers can read simultaneously.

ZRef.Synchronized also supports composing multiple ZRef.Synchronized values together to form a single ZRef.Synchronized value that can be atomically updated using the zip operator. In this case reads and writes will semantically block other readers and writers.

NOTE: While ZRef provides the functional equivalent of a mutable reference, the value inside the ZRef should normally be immutable since compare and swap operations are not safe for mutable values that do not support concurrent access. If you do need to use a mutable value ZRef.Synchronized will guarantee that access to the value is properly synchronized.

Self Type
ZRef[RA, RB, EA, EB, A, B]
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZRef
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def fold[EC, ED, C, D](ea: (EA) => EC, eb: (EB) => ED, ca: (C) => Either[EC, A], bd: (B) => Either[ED, D]): ZRef[RA, RB, EC, ED, C, D]

    Folds over the error and value types of the ZRef.

    Folds over the error and value types of the ZRef. This is a highly polymorphic method that is capable of arbitrarily transforming the error and value types of the ZRef. For most use cases one of the more specific combinators implemented in terms of fold will be more ergonomic but this method is extremely useful for implementing new combinators.

  2. abstract def foldAll[EC, ED, C, D](ea: (EA) => EC, eb: (EB) => ED, ec: (EB) => EC, ca: (C) => (B) => Either[EC, A], bd: (B) => Either[ED, D]): ZRef[RA with RB, RB, EC, ED, C, D]

    Folds over the error and value types of the ZRef, allowing access to the state in transforming the set value.

    Folds over the error and value types of the ZRef, allowing access to the state in transforming the set value. This is a more powerful version of fold but requires unifying the error types.

  3. abstract def get: ZIO[RB, EB, B]

    Reads the value from the ZRef.

  4. abstract def set(a: A): ZIO[RA, EA, Unit]

    Writes a new value to the ZRef, with a guarantee of immediate consistency (at some cost to performance).

  5. abstract def setAsync(a: A): ZIO[RA, EA, Unit]

    Writes a new value to the ZRef without providing a guarantee of immediate consistency.

Concrete 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()
  6. def collect[C](pf: PartialFunction[B, C]): ZRef[RA, RB, EA, Option[EB], A, C]

    Maps and filters the get value of the ZRef with the specified partial function, returning a ZRef with a get value that succeeds with the result of the partial function if it is defined or else fails with None.

  7. def contramap[C](f: (C) => A): ZRef[RA, RB, EA, EB, C, B]

    Transforms the set value of the ZRef with the specified function.

  8. def contramapEither[EC >: EA, C](f: (C) => Either[EC, A]): ZRef[RA, RB, EC, EB, C, B]

    Transforms the set value of the ZRef with the specified fallible function.

  9. def dimap[C, D](f: (C) => A, g: (B) => D): ZRef[RA, RB, EA, EB, C, D]

    Transforms both the set and get values of the ZRef with the specified functions.

  10. def dimapEither[EC >: EA, ED >: EB, C, D](f: (C) => Either[EC, A], g: (B) => Either[ED, D]): ZRef[RA, RB, EC, ED, C, D]

    Transforms both the set and get values of the ZRef with the specified fallible functions.

  11. def dimapError[EC, ED](f: (EA) => EC, g: (EB) => ED): ZRef[RA, RB, EC, ED, A, B]

    Transforms both the set and get errors of the ZRef with the specified functions.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def filterInput[A1 <: A](f: (A1) => Boolean): ZRef[RA, RB, Option[EA], EB, A1, B]

    Filters the set value of the ZRef with the specified predicate, returning a ZRef with a set value that succeeds if the predicate is satisfied or else fails with None.

  15. def filterOutput(f: (B) => Boolean): ZRef[RA, RB, EA, Option[EB], A, B]

    Filters the get value of the ZRef with the specified predicate, returning a ZRef with a get value that succeeds if the predicate is satisfied or else fails with None.

  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def map[C](f: (B) => C): ZRef[RA, RB, EA, EB, A, C]

    Transforms the get value of the ZRef with the specified function.

  21. def mapEither[EC >: EB, C](f: (B) => Either[EC, C]): ZRef[RA, RB, EA, EC, A, C]

    Transforms the get value of the ZRef with the specified fallible function.

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def readOnly: ZRef[RA, RB, EA, EB, Nothing, B]

    Returns a read only view of the ZRef.

  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. def writeOnly: ZRef[RA, RB, EA, Unit, A, Nothing]

    Returns a write only view of the ZRef.

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped