optics

Type Members

implicit class AtZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

Provides implicit syntax for accessing the specified index of a chunk in a ZRef.
implicit class ConsZRefSyntax[EA, EB >: OpticFailure, A] extends AnyRef

Provides implicit syntax for accessing the :: case of a List in a ZRef.
type EOptic[-GetWhole, -SetWholeBefore, -SetPiece, +Error, +GetPiece, +SetWholeAfter] = (OpticTypesModule.this)#Optic[GetWhole, SetWholeBefore, SetPiece, Error, Error, GetPiece, SetWholeAfter]

Definition Classes
OpticTypesModule
implicit class ERefSyntax[EA >: EB, EB, A, B] extends AnyRef

Providing implicit syntax for accessing pieces of a value in a ZRef when the error types are unified.
implicit class FilterZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

Provides implicit syntax for accessing a filtered subset of a chunk in a ZRef.
implicit class FirstZRefSyntax[EA >: EB, EB, A, B, C] extends AnyRef

Provides implicit syntax for accessing the first element of a tuple in a ZRef.
type Fold[-S, +A] = (OpticTypesModule.this)#Optic[S, Nothing, Nothing, (OpticTypesModule.this)#OpticFailure, Any, Chunk[A], Any]

Definition Classes
OpticTypesModule
type Getter[-S, +A] = (OpticTypesModule.this)#Optic[S, Nothing, Nothing, (OpticTypesModule.this)#OpticFailure, Any, A, Any]

Definition Classes
OpticTypesModule
implicit class HeadZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

Provides implicit syntax for accessing the head of a list in a ZRef.
type Iso[S, A] = (OpticTypesModule.this)#Optic[S, Any, A, Nothing, Nothing, A, S]

Definition Classes
OpticTypesModule
type IsoPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, Nothing, Nothing, A, S]

Definition Classes
OpticTypesModule
implicit class KeyZRefSyntax[EA >: EB, EB >: OpticFailure, K, V] extends AnyRef

Provides implicit syntax for accessing the value at the specified key in a map in a ZRef.
implicit class LeftZRefSyntax[EA, EB >: OpticFailure, A, B, C] extends AnyRef

Provides implicit syntax for accessing the Left case of an Either in a ZRef.
type Lens[S, A] = (OpticTypesModule.this)#Optic[S, S, A, Nothing, Nothing, A, S]

Definition Classes
OpticTypesModule
type LensPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, Nothing, Nothing, A, S]

Definition Classes
OpticTypesModule
trait LowPriorityOpticCompose extends AnyRef

Definition Classes
OpticComposeModule
implicit class NoneZRefSyntax[EA, EB >: OpticFailure, A] extends AnyRef

Provides implicit syntax for accessing the None case of an Option in a ZRef.
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
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
trait OpticComposeModule extends AnyRef
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
trait OpticFailureModule extends AnyRef
trait OpticModule extends AnyRef
type OpticPartiallyApplied[-SetPiece, +GetError, +SetError, +GetPiece, +SetWhole] = (OpticTypesModule.this)#Optic[Any, Any, SetPiece, GetError, SetError, GetPiece, SetWhole]

Definition Classes
OpticTypesModule
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
trait OpticResultModule extends AnyRef
trait OpticTypesModule extends AnyRef
trait Optics extends OpticComposeModule with OpticFailureModule with OpticModule with OpticResultModule with OpticTypesModule
type Optional[S, A] = (OpticTypesModule.this)#Optic[S, S, A, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, S]

Definition Classes
OpticTypesModule
type OptionalPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, S]

Definition Classes
OpticTypesModule
type Prism[S, A] = (OpticTypesModule.this)#Optic[S, Any, A, (OpticTypesModule.this)#OpticFailure, Nothing, A, S]

Definition Classes
OpticTypesModule
type PrismPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, (OpticTypesModule.this)#OpticFailure, Nothing, A, S]

Definition Classes
OpticTypesModule
implicit class RightZRefSyntax[EA, EB >: OpticFailure, A, B, C] extends AnyRef

Provides implicit syntax for accessing the Right case of an Either in a ZRef.
implicit class SecondZRefSyntax[EA >: EB, EB, A, B, C] extends AnyRef

Provides implicit syntax for accessing the second element of a tuple in a ZRef.
type Setter[S, -A] = (OpticTypesModule.this)#Optic[Nothing, S, A, Any, (OpticTypesModule.this)#OpticFailure, Any, S]

Definition Classes
OpticTypesModule
implicit class SliceZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

Provides implicit syntax for accessing a slice of a chunk in a ZRef.
implicit class SomeZRefSyntax[EA, EB >: OpticFailure, A, B] extends AnyRef

Provides implicit syntax for accessing the Some case of an Option in a ZRef.
implicit class TailZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

Provides implicit syntax for accessing the tail of a list in a ZRef.
type Traversal[S, A] = (OpticTypesModule.this)#Optic[S, S, Chunk[A], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], S]

Definition Classes
OpticTypesModule
type TraversalPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, Chunk[A], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], S]

Definition Classes
OpticTypesModule
type ZIso[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, Any, B, Nothing, Nothing, A, T]

Definition Classes
OpticTypesModule
type ZIsoPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, Nothing, Nothing, A, S]

Definition Classes
OpticTypesModule
type ZLens[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, S, B, Nothing, Nothing, A, T]

Definition Classes
OpticTypesModule
type ZLensPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, Nothing, Nothing, A, S]

Definition Classes
OpticTypesModule
type ZOptional[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, S, B, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, T]

Definition Classes
OpticTypesModule
type ZOptionalPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, S]

Definition Classes
OpticTypesModule
type ZPrism[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, Any, B, (OpticTypesModule.this)#OpticFailure, Nothing, A, T]

Definition Classes
OpticTypesModule
type ZPrismPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, (OpticTypesModule.this)#OpticFailure, Nothing, A, S]

Definition Classes
OpticTypesModule
implicit class ZRefSyntax[EA, EB, A, B] extends AnyRef

Providing implicit syntax for accessing pieces of a value in a ZRef.
type ZSetter[-S, +T, -A] = (OpticTypesModule.this)#Optic[Nothing, S, A, Any, (OpticTypesModule.this)#OpticFailure, Any, T]

Definition Classes
OpticTypesModule
type ZTraversal[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, S, Chunk[B], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], T]

Definition Classes
OpticTypesModule
type ZTraversalPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, Chunk[B], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], S]

Definition Classes
OpticTypesModule

Abstract Value Members

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

object BuildInfo extends Product with Serializable

This object was generated by sbt-buildinfo.
object Iso extends Serializable

Definition Classes
OpticTypesModule
object Lens extends Serializable

Definition Classes
OpticTypesModule
object Optic extends Serializable

Definition Classes
OpticModule
object OpticCompose extends (OpticComposeModule.this)#LowPriorityOpticCompose

Definition Classes
OpticComposeModule
object Optional extends Serializable

Definition Classes
OpticTypesModule
object Prism extends Serializable

Definition Classes
OpticTypesModule
object Traversal extends Serializable

Definition Classes
OpticTypesModule
object ZIso extends Serializable

Definition Classes
OpticTypesModule
object ZLens extends Serializable

Definition Classes
OpticTypesModule
object ZOptional extends Serializable

Definition Classes
OpticTypesModule
object ZPrism extends Serializable

Definition Classes
OpticTypesModule
object ZTraversal extends Serializable

Definition Classes
OpticTypesModule
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
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
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
package opticsm
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
package toptics
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
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

package optics

Type Members

implicit class AtZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

implicit class ConsZRefSyntax[EA, EB >: OpticFailure, A] extends AnyRef

type EOptic[-GetWhole, -SetWholeBefore, -SetPiece, +Error, +GetPiece, +SetWholeAfter] = (OpticTypesModule.this)#Optic[GetWhole, SetWholeBefore, SetPiece, Error, Error, GetPiece, SetWholeAfter]

implicit class ERefSyntax[EA >: EB, EB, A, B] extends AnyRef

implicit class FilterZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

implicit class FirstZRefSyntax[EA >: EB, EB, A, B, C] extends AnyRef

type Fold[-S, +A] = (OpticTypesModule.this)#Optic[S, Nothing, Nothing, (OpticTypesModule.this)#OpticFailure, Any, Chunk[A], Any]

type Getter[-S, +A] = (OpticTypesModule.this)#Optic[S, Nothing, Nothing, (OpticTypesModule.this)#OpticFailure, Any, A, Any]

implicit class HeadZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

type Iso[S, A] = (OpticTypesModule.this)#Optic[S, Any, A, Nothing, Nothing, A, S]

type IsoPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, Nothing, Nothing, A, S]

implicit class KeyZRefSyntax[EA >: EB, EB >: OpticFailure, K, V] extends AnyRef

implicit class LeftZRefSyntax[EA, EB >: OpticFailure, A, B, C] extends AnyRef

type Lens[S, A] = (OpticTypesModule.this)#Optic[S, S, A, Nothing, Nothing, A, S]

type LensPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, Nothing, Nothing, A, S]

trait LowPriorityOpticCompose extends AnyRef

implicit class NoneZRefSyntax[EA, EB >: OpticFailure, A] extends AnyRef

trait OpticCompose[GetWhole, SetWholeBefore, SetWholeBefore1, SetWholeBefore2, GetError, SetError, SetError1, GetPiece] extends AnyRef

trait OpticComposeModule extends AnyRef

case class OpticFailure(message: String) extends Exception with Product with Serializable

trait OpticFailureModule extends AnyRef

trait OpticModule extends AnyRef

type OpticPartiallyApplied[-SetPiece, +GetError, +SetError, +GetPiece, +SetWhole] = (OpticTypesModule.this)#Optic[Any, Any, SetPiece, GetError, SetError, GetPiece, SetWhole]

abstract type OpticResult[+E, +A]

trait OpticResultModule extends AnyRef

trait OpticTypesModule extends AnyRef

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

type Optional[S, A] = (OpticTypesModule.this)#Optic[S, S, A, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, S]

type OptionalPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, S]

type Prism[S, A] = (OpticTypesModule.this)#Optic[S, Any, A, (OpticTypesModule.this)#OpticFailure, Nothing, A, S]

type PrismPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, A, (OpticTypesModule.this)#OpticFailure, Nothing, A, S]

implicit class RightZRefSyntax[EA, EB >: OpticFailure, A, B, C] extends AnyRef

implicit class SecondZRefSyntax[EA >: EB, EB, A, B, C] extends AnyRef

type Setter[S, -A] = (OpticTypesModule.this)#Optic[Nothing, S, A, Any, (OpticTypesModule.this)#OpticFailure, Any, S]

implicit class SliceZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

implicit class SomeZRefSyntax[EA, EB >: OpticFailure, A, B] extends AnyRef

implicit class TailZRefSyntax[EA >: EB, EB >: OpticFailure, A] extends AnyRef

type Traversal[S, A] = (OpticTypesModule.this)#Optic[S, S, Chunk[A], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], S]

type TraversalPartiallyApplied[+S, A] = (OpticTypesModule.this)#Optic[Any, Any, Chunk[A], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], S]

type ZIso[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, Any, B, Nothing, Nothing, A, T]

type ZIsoPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, Nothing, Nothing, A, S]

type ZLens[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, S, B, Nothing, Nothing, A, T]

type ZLensPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, Nothing, Nothing, A, S]

type ZOptional[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, S, B, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, T]

type ZOptionalPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, A, S]

type ZPrism[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, Any, B, (OpticTypesModule.this)#OpticFailure, Nothing, A, T]

type ZPrismPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, B, (OpticTypesModule.this)#OpticFailure, Nothing, A, S]

implicit class ZRefSyntax[EA, EB, A, B] extends AnyRef

type ZSetter[-S, +T, -A] = (OpticTypesModule.this)#Optic[Nothing, S, A, Any, (OpticTypesModule.this)#OpticFailure, Any, T]

type ZTraversal[-S, +T, +A, -B] = (OpticTypesModule.this)#Optic[S, S, Chunk[B], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], T]

type ZTraversalPartiallyApplied[+S, +A, -B] = (OpticTypesModule.this)#Optic[Any, Any, Chunk[B], (OpticTypesModule.this)#OpticFailure, (OpticTypesModule.this)#OpticFailure, Chunk[A], S]

Abstract Value Members

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

abstract def flatMap[E, A, B](opticResult: OpticResult[E, A])(f: (A) ⇒ OpticResult[E, B]): OpticResult[E, B]

abstract def foldM[E, E2, A, B](opticResult: OpticResult[E, A])(f: (E) ⇒ OpticResult[E2, B], g: (A) ⇒ OpticResult[E2, B]): OpticResult[E2, B]

abstract def map[E, A, B](opticResult: OpticResult[E, A])(f: (A) ⇒ B): OpticResult[E, B]

abstract def succeed[A](a: A): OpticResult[Nothing, A]

Concrete Value Members

object BuildInfo extends Product with Serializable

object Iso extends Serializable

object Lens extends Serializable

object Optic extends Serializable

object OpticCompose extends (OpticComposeModule.this)#LowPriorityOpticCompose

object Optional extends Serializable

object Prism extends Serializable

object Traversal extends Serializable

object ZIso extends Serializable

object ZLens extends Serializable

object ZOptional extends Serializable

object ZPrism extends Serializable

object ZTraversal extends Serializable

final def collectAllSuccesses[E, A](iterable: Iterable[OpticResult[E, A]]): OpticResult[Nothing, Chunk[A]]

final def foreach[E, A, B](iterable: Iterable[A])(f: (A) ⇒ OpticResult[E, B]): OpticResult[E, Chunk[B]]

final def mapError[E, E2, A](opticResult: OpticResult[E, A])(f: (E) ⇒ E2): OpticResult[E2, A]

package opticsm

final def orElse[E, E2, A](left: ⇒ OpticResult[E, A], right: ⇒ OpticResult[E2, A]): OpticResult[E2, A]

package toptics