p

zio.optics

toptics

package toptics

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. toptics
  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. implicit class AtZTRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

    Provides implicit syntax for accessing the specified index of a chunk in a ZTRef.

  6. implicit class ConsZTRefSyntax[EA, EB >: OpticFailure, A] extends AnyRef

    Provides implicit syntax for accessing the :: case of a List in a ZTRef.

  7. type EOptic[-GetWhole, -SetWholeBefore, -SetPiece, +Error, +GetPiece, +SetWholeAfter] = Optic[GetWhole, SetWholeBefore, SetPiece, Error, Error, GetPiece, SetWholeAfter]
    Definition Classes
    OpticTypesModule
  8. implicit class ETRefSyntax[EA >: EB, EB, A, B] extends AnyRef

    Providing implicit syntax for accessing pieces of a value in a ZTRef when the error types are unified.

  9. implicit class FilterZTRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

    Provides implicit syntax for accessing a filtered subset of a chunk in a ZTRef.

  10. implicit class FirstZTRefSyntax[EA >: EB, EB, A, B, C] extends AnyRef

    Provides implicit syntax for accessing the first element of a tuple in a ZTRef.

  11. type Fold[-S, +A] = Optic[S, Nothing, Nothing, OpticFailure, Any, Chunk[A], Any]
    Definition Classes
    OpticTypesModule
  12. type Getter[-S, +A] = Optic[S, Nothing, Nothing, OpticFailure, Any, A, Any]
    Definition Classes
    OpticTypesModule
  13. implicit class HeadZTRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

    Provides implicit syntax for accessing the head of a list in a ZTRef.

  14. type Iso[S, A] = Optic[S, Any, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  15. type IsoPartiallyApplied[+S, A] = Optic[Any, Any, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  16. implicit class KeyZTRefSyntax[EA >: EB, EB >: OpticFailure, K, V] extends AnyRef

    Provides implicit syntax for accessing the value at the specified key in a map in a ZTRef.

  17. implicit class LeftZTRefSyntax[EA, EB >: OpticFailure, A, B, C] extends AnyRef

    Provides implicit syntax for accessing the Left case of an Either in a ZTRef.

  18. type Lens[S, A] = Optic[S, S, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  19. type LensPartiallyApplied[+S, A] = Optic[Any, Any, A, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  20. implicit class NoneZTRefSyntax[EA, EB >: OpticFailure, A] extends AnyRef

    Provides implicit syntax for accessing the None case of an Option in a ZTRef.

  21. type OpticPartiallyApplied[-SetPiece, +GetError, +SetError, +GetPiece, +SetWhole] = Optic[Any, Any, SetPiece, GetError, SetError, GetPiece, SetWhole]
    Definition Classes
    OpticTypesModule
  22. 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
  23. type Optional[S, A] = Optic[S, S, A, OpticFailure, OpticFailure, A, S]
    Definition Classes
    OpticTypesModule
  24. type OptionalPartiallyApplied[+S, A] = Optic[Any, Any, A, OpticFailure, OpticFailure, A, S]
    Definition Classes
    OpticTypesModule
  25. type Prism[S, A] = Optic[S, Any, A, OpticFailure, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  26. type PrismPartiallyApplied[+S, A] = Optic[Any, Any, A, OpticFailure, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  27. implicit class RightZTRefSyntax[EA, EB >: OpticFailure, A, B, C] extends AnyRef

    Provides implicit syntax for accessing the Right case of an Either in a ZTRef.

  28. implicit class SecondZTRefSyntax[EA >: EB, EB, A, B, C] extends AnyRef

    Provides implicit syntax for accessing the second element of a tuple in a ZTRef.

  29. type Setter[S, -A] = Optic[Nothing, S, A, Any, OpticFailure, Any, S]
    Definition Classes
    OpticTypesModule
  30. implicit class SliceZTRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

    Provides implicit syntax for accessing a slice of a chunk in a ZTRef.

  31. implicit class SomeZTRefSyntax[EA, EB >: OpticFailure, A, B] extends AnyRef

    Provides implicit syntax for accessing the Some case of an Option in a ZTRef.

  32. implicit final class TMapOpticsSyntax[K, V] extends AnyRef

    Provides implicit syntax accessing the value at the specified key in a TMap.

  33. implicit class TailZTRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

    Provides implicit syntax for accessing the tail of a list in a ZTRef.

  34. type Traversal[S, A] = Optic[S, S, Chunk[A], OpticFailure, OpticFailure, Chunk[A], S]
    Definition Classes
    OpticTypesModule
  35. type TraversalPartiallyApplied[+S, A] = Optic[Any, Any, Chunk[A], OpticFailure, OpticFailure, Chunk[A], S]
    Definition Classes
    OpticTypesModule
  36. type ZIso[-S, +T, +A, -B] = Optic[S, Any, B, Nothing, Nothing, A, T]
    Definition Classes
    OpticTypesModule
  37. type ZIsoPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  38. type ZLens[-S, +T, +A, -B] = Optic[S, S, B, Nothing, Nothing, A, T]
    Definition Classes
    OpticTypesModule
  39. type ZLensPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, Nothing, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  40. type ZOptional[-S, +T, +A, -B] = Optic[S, S, B, OpticFailure, OpticFailure, A, T]
    Definition Classes
    OpticTypesModule
  41. type ZOptionalPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, OpticFailure, OpticFailure, A, S]
    Definition Classes
    OpticTypesModule
  42. type ZPrism[-S, +T, +A, -B] = Optic[S, Any, B, OpticFailure, Nothing, A, T]
    Definition Classes
    OpticTypesModule
  43. type ZPrismPartiallyApplied[+S, +A, -B] = Optic[Any, Any, B, OpticFailure, Nothing, A, S]
    Definition Classes
    OpticTypesModule
  44. type ZSetter[-S, +T, -A] = Optic[Nothing, S, A, Any, OpticFailure, Any, T]
    Definition Classes
    OpticTypesModule
  45. implicit class ZTRefSyntax[EA, EB, A, B] extends AnyRef

    Providing implicit syntax for accessing pieces of a value in a ZTRef.

  46. type ZTraversal[-S, +T, +A, -B] = Optic[S, S, Chunk[B], OpticFailure, OpticFailure, Chunk[A], T]
    Definition Classes
    OpticTypesModule
  47. 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): toptics.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: toptics.OpticResult[E, A])(f: (A) => toptics.OpticResult[E, B]): toptics.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: toptics.OpticResult[E, A])(f: (E) => toptics.OpticResult[E2, B], g: (A) => toptics.OpticResult[E2, B]): toptics.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: toptics.OpticResult[E, A])(f: (A) => B): toptics.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): toptics.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 collectAllSuccesses[E, A](iterable: Iterable[toptics.OpticResult[E, A]]): toptics.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
  14. final def foreach[E, A, B](iterable: Iterable[A])(f: (A) => toptics.OpticResult[E, B]): toptics.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
  15. final def mapError[E, E2, A](opticResult: toptics.OpticResult[E, A])(f: (E) => E2): toptics.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
  16. final def orElse[E, E2, A](left: => toptics.OpticResult[E, A], right: => toptics.OpticResult[E2, A]): toptics.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
  17. final def zip[E, A, B](left: => toptics.OpticResult[E, A], right: => toptics.OpticResult[E, B]): toptics.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
  18. final def zipWith[E, A, B, C](left: => toptics.OpticResult[E, A], right: => toptics.OpticResult[E, B])(f: (A, B) => C): toptics.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
  19. object TOptics

Inherited from OpticTypesModule

Inherited from OpticResultModule

Inherited from OpticModule

Inherited from OpticFailureModule

Inherited from OpticComposeModule

Inherited from AnyRef

Inherited from Any

Ungrouped