t

zio.optics

Optics

trait Optics extends OpticComposeModule with OpticFailureModule with OpticModule with OpticResultModule with OpticTypesModule

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Optics
  2. OpticTypesModule
  3. OpticResultModule
  4. OpticModule
  5. OpticFailureModule
  6. OpticComposeModule
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait LowPriorityOpticCompose extends AnyRef
    Definition Classes
    OpticComposeModule
  2. trait OpticCompose[GetWhole, SetWholeBefore, SetWholeBefore1, SetWholeBefore2, GetError, SetError, SetError1, GetPiece] extends AnyRef

    OpticCompose abstracts over the different ways that optics can be composed together, allowing all optics to be composed with a single operator.

    OpticCompose abstracts over the different ways that optics can be composed together, allowing all optics to be composed with a single operator.

    Definition Classes
    OpticComposeModule
  3. case class OpticFailure(message: String) extends Exception with Product with Serializable

    An OpticFailure describes how getting or setting a piece of a whole using an optic failed.

    An OpticFailure describes how getting or setting a piece of a whole using an optic failed.

    Definition Classes
    OpticFailureModule
  4. case class Optic[-GetWhole, -SetWholeBefore, -SetPiece, +GetError, +SetError, +GetPiece, +SetWholeAfter](getOptic: (GetWhole) => (OpticModule.this)#OpticResult[(GetError, SetWholeAfter), GetPiece], setOptic: (SetPiece) => (SetWholeBefore) => (OpticModule.this)#OpticResult[(SetError, SetWholeAfter), SetWholeAfter]) extends Product with Serializable

    An Optic is able to get and set a piece of a whole, possibly failing.

    An Optic is able to get and set a piece of a whole, possibly failing. In the most general possible case the get and set types are distinct and getting may fail with a different error than setting.

    Definition Classes
    OpticModule
  5. type EOptic[-GetWhole, -SetWholeBefore, -SetPiece, +Error, +GetPiece, +SetWholeAfter] = Optic[GetWhole, SetWholeBefore, SetPiece, Error, Error, GetPiece, SetWholeAfter]
    Definition Classes
    OpticTypesModule
  6. type Fold[-S, +A] = Optic[S, Nothing, Nothing, OpticFailure, Any, Chunk[A], Any]
    Definition Classes
    OpticTypesModule
  7. type Getter[-S, +A] = Optic[S, Nothing, Nothing, OpticFailure, Any, A, Any]
    Definition Classes
    OpticTypesModule
  8. type Iso[S, A] = Optic[S, Any, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  9. type IsoPartiallyApplied[+S, A] = Optic[Any, Any, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  10. type Lens[S, A] = Optic[S, S, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  11. type LensPartiallyApplied[+S, A] = Optic[Any, Any, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  12. type OpticPartiallyApplied[-SetPiece, +GetError, +SetError, +GetPiece, +SetWhole] = Optic[Any, Any, SetPiece, GetError, SetError, GetPiece, SetWhole]
    Definition Classes
    OpticTypesModule
  13. abstract type OpticResult[+E, +A]

    An OpticResult represents the result from getting or setting a piece of a whole using an optic.

    An OpticResult represents the result from getting or setting a piece of a whole using an optic. This allows the library to abstract over pure optics, transactional optics, and effectual optics.

    Definition Classes
    OpticResultModule
  14. implicit final class OpticSyntax[Whole] extends AnyRef

    Provides implicit syntax for working with any value as a partially applied optic.

  15. type Optional[S, A] = Optic[S, S, A, OpticFailure, OpticFailure, A, S]
    Definition Classes
    OpticTypesModule
  16. type OptionalPartiallyApplied[+S, A] = Optic[Any, Any, A, OpticFailure, OpticFailure, A, S]
    Definition Classes
    OpticTypesModule
  17. type Prism[S, A] = Optic[S, Any, A, OpticFailure, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  18. type PrismPartiallyApplied[+S, A] = Optic[Any, Any, A, OpticFailure, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  19. type Setter[S, -A] = Optic[Nothing, S, A, Any, OpticFailure, Any, S]
    Definition Classes
    OpticTypesModule
  20. type Traversal[S, A] = Optic[S, S, Chunk[A], OpticFailure, OpticFailure, Chunk[A], S]
    Definition Classes
    OpticTypesModule
  21. type TraversalPartiallyApplied[+S, A] = Optic[Any, Any, Chunk[A], OpticFailure, OpticFailure, Chunk[A], S]
    Definition Classes
    OpticTypesModule
  22. type ZIso[-S, +T, +A, -B] = Optic[S, Any, B, Nothing, Nothing, A, T]
    Definition Classes
    OpticTypesModule
  23. type ZIsoPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  24. type ZLens[-S, +T, +A, -B] = Optic[S, S, B, Nothing, Nothing, A, T]
    Definition Classes
    OpticTypesModule
  25. type ZLensPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  26. type ZOptional[-S, +T, +A, -B] = Optic[S, S, B, OpticFailure, OpticFailure, A, T]
    Definition Classes
    OpticTypesModule
  27. type ZOptionalPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, OpticFailure, OpticFailure, A, S]
    Definition Classes
    OpticTypesModule
  28. type ZPrism[-S, +T, +A, -B] = Optic[S, Any, B, OpticFailure, Nothing, A, T]
    Definition Classes
    OpticTypesModule
  29. type ZPrismPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, OpticFailure, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  30. type ZSetter[-S, +T, -A] = Optic[Nothing, S, A, Any, OpticFailure, Any, T]
    Definition Classes
    OpticTypesModule
  31. type ZTraversal[-S, +T, +A, -B] = Optic[S, S, Chunk[B], OpticFailure, OpticFailure, Chunk[A], T]
    Definition Classes
    OpticTypesModule
  32. type ZTraversalPartiallyApplied[+S, +A, -B] = Optic[Any, Any, Chunk[B], OpticFailure, OpticFailure, Chunk[A], S]
    Definition Classes
    OpticTypesModule

Abstract Value Members

  1. abstract def fail[E](e: E): OpticResult[E, Nothing]

    Constructs an optic result that fails with the specified value.

    Constructs an optic result that fails with the specified value.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  2. abstract def flatMap[E, A, B](opticResult: OpticResult[E, A])(f: (A) => OpticResult[E, B]): OpticResult[E, B]

    Constructs an optic result by applying a function that returns an optic result to the success value of the specified optic result.

    Constructs an optic result by applying a function that returns an optic result to the success value of the specified optic result.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  3. abstract def foldM[E, E2, A, B](opticResult: OpticResult[E, A])(f: (E) => OpticResult[E2, B], g: (A) => OpticResult[E2, B]): OpticResult[E2, B]

    Constructs an optic results that folds over the success and failure values of the specified optic result, transforming them with the functions f and g that return an optic result.

    Constructs an optic results that folds over the success and failure values of the specified optic result, transforming them with the functions f and g that return an optic result.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  4. abstract def map[E, A, B](opticResult: OpticResult[E, A])(f: (A) => B): OpticResult[E, B]

    Constructs an optic result by applying a function to the success value of this optic result.

    Constructs an optic result by applying a function to the success value of this optic result.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  5. abstract def succeed[A](a: A): OpticResult[Nothing, A]

    Constructs an optic result that succeeds with the specified value.

    Constructs an optic result that succeeds with the specified value.

    Attributes
    protected
    Definition Classes
    OpticResultModule

Concrete Value Members

  1. object OpticCompose extends (OpticComposeModule.this)#LowPriorityOpticCompose
    Definition Classes
    OpticComposeModule
  2. object Optic extends Serializable
    Definition Classes
    OpticModule
  3. object Iso
    Definition Classes
    OpticTypesModule
  4. object Lens
    Definition Classes
    OpticTypesModule
  5. object Optional
    Definition Classes
    OpticTypesModule
  6. object Prism
    Definition Classes
    OpticTypesModule
  7. object Traversal
    Definition Classes
    OpticTypesModule
  8. object ZIso
    Definition Classes
    OpticTypesModule
  9. object ZLens
    Definition Classes
    OpticTypesModule
  10. object ZOptional
    Definition Classes
    OpticTypesModule
  11. object ZPrism
    Definition Classes
    OpticTypesModule
  12. object ZTraversal
    Definition Classes
    OpticTypesModule
  13. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. final def ##: Int
    Definition Classes
    AnyRef → Any
  15. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  18. final def collectAllSuccesses[E, A](iterable: Iterable[OpticResult[E, A]]): OpticResult[Nothing, Chunk[A]]

    Constructs an optic result that succeeds with all the success values in the specified collection of optic results, discarding the failures.

    Constructs an optic result that succeeds with all the success values in the specified collection of optic results, discarding the failures.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. final def foreach[E, A, B](iterable: Iterable[A])(f: (A) => OpticResult[E, B]): OpticResult[E, Chunk[B]]

    Constructs an optic result that applies a function returning an optic result to each element in the specified collection and collects the results into a single optic result.

    Constructs an optic result that applies a function returning an optic result to each element in the specified collection and collects the results into a single optic result.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def mapError[E, E2, A](opticResult: OpticResult[E, A])(f: (E) => E2): OpticResult[E2, A]

    Constructs an optic result by applying a function to the failure value of this optic result.

    Constructs an optic result by applying a function to the failure value of this optic result.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def orElse[E, E2, A](left: => OpticResult[E, A], right: => OpticResult[E2, A]): OpticResult[E2, A]

    Constructs an optic result that is equal to the left optic result if it is successful or else the right optic result.

    Constructs an optic result that is equal to the left optic result if it is successful or else the right optic result.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. final def zip[E, A, B](left: => OpticResult[E, A], right: => OpticResult[E, B]): OpticResult[E, (A, B)]

    Constructs an optic result that combines the left and right optic results.

    Constructs an optic result that combines the left and right optic results.

    Attributes
    protected
    Definition Classes
    OpticResultModule
  37. final def zipWith[E, A, B, C](left: => OpticResult[E, A], right: => OpticResult[E, B])(f: (A, B) => C): OpticResult[E, C]

    Constructs an optic result that combines the left and right optic results, transforming their success values with the specified function.

    Constructs an optic result that combines the left and right optic results, transforming their success values with the specified function.

    Attributes
    protected
    Definition Classes
    OpticResultModule

Inherited from OpticTypesModule

Inherited from OpticResultModule

Inherited from OpticModule

Inherited from OpticFailureModule

Inherited from OpticComposeModule

Inherited from AnyRef

Inherited from Any

Ungrouped