zio-optics/zio.optics/OpticModule/Optic

Optic

object Optic
Companion
class
trait Product
trait Mirror
class Object
trait Matchable
class Any

Type members

Classlikes

class AtPartiallyAppliedSyntax[GetError >: OpticFailure, SetError >: GetError, Piece, Whole](self: Optic[Any, Any, Chunk[Piece], GetError, SetError, Chunk[Piece], Whole])

Provides implicit syntax for accessing the specified index of a chunk accessed by a partially applied optic.

Provides implicit syntax for accessing the specified index of a chunk accessed by a partially applied optic.

class ComposeSyntax[GetWhole, SetWholeBefore, SetPiece, GetError, SetError, GetPiece, SetWholeAfter](self: Optic[GetWhole, SetWholeBefore, SetPiece, GetError, SetError, GetPiece, SetWholeAfter])

Provides implicit syntax for composing optics.

Provides implicit syntax for composing optics.

class ConsPartiallyAppliedSyntax[SetPiece, GetError >: OpticFailure, SetError, GetPiece, SetWhole](self: Optic[Any, Any, List[SetPiece], GetError, SetError, List[GetPiece], SetWhole])

Provides implicit syntax for accessing the :: case of a List accessed by a partially applied optic.

Provides implicit syntax for accessing the :: case of a List accessed by a partially applied optic.

class EOpticSyntax[GetWhole, SetWholeBefore, SetPiece, Error, GetPiece, SetWholeAfter](self: EOptic[GetWhole, SetWholeBefore, SetPiece, Error, GetPiece, SetWholeAfter])

Provides implicit syntax for when the error types of getting and setting are unified.

Provides implicit syntax for when the error types of getting and setting are unified.

class FilterPartiallyAppliedSyntax[GetError >: OpticFailure, SetError >: GetError, Piece, Whole](self: Optic[Any, Any, Chunk[Piece], GetError, SetError, Chunk[Piece], Whole])

Provides implicit syntax for accessing a filtered subset of a chunk accessed by a partially applied optic.

Provides implicit syntax for accessing a filtered subset of a chunk accessed by a partially applied optic.

class FirstPartiallyAppliedSyntax[SetPiece, GetError, SetError >: GetError, GetPiece, Whole, Piece2](self: Optic[Any, Any, (SetPiece, Piece2), GetError, SetError, (GetPiece, Piece2), Whole])

Provides implicit syntax for accessing the first element of a tuple accessed by a partially applied optic.

Provides implicit syntax for accessing the first element of a tuple accessed by a partially applied optic.

class ForEachSyntax[GetWhole, SetWholeBefore <: GetWhole, SetPiece, GetError >: SetError, SetError, SetError1 >: GetError, GetPiece, SetWholeAfter](left: Optic[GetWhole, SetWholeBefore, Chunk[SetPiece], GetError, SetError, Chunk[GetPiece], SetWholeAfter])

Provides implicit syntax for applying an optic to each element of a collection accessed by another optic.

Provides implicit syntax for applying an optic to each element of a collection accessed by another optic.

class HeadPartiallyAppliedSyntax[GetError >: OpticFailure, SetError >: GetError, Piece, Whole](self: Optic[Any, Any, List[Piece], GetError, SetError, List[Piece], Whole])

Provides implicit syntax for accessing the head of a list accessed by a partially applied optic.

Provides implicit syntax for accessing the head of a list accessed by a partially applied optic.

class IsoSyntax[Whole, Piece](self: Iso[Whole, Piece])

Provides implicit syntax for when the optic is an isomorphism.

Provides implicit syntax for when the optic is an isomorphism.

class KeyPartiallyAppliedSyntax[GetError >: OpticFailure, SetError >: GetError, Key, Value, Whole](self: Optic[Any, Any, Map[Key, Value], GetError, SetError, Map[Key, Value], Whole])

Provides implicit syntax for accessing the value at the specified key in a map accessed by a partially applied optic.

Provides implicit syntax for accessing the value at the specified key in a map accessed by a partially applied optic.

class LeftPartiallyAppliedSyntax[SetPiece, GetError >: OpticFailure, SetError, GetPiece, SetWhole, Piece2](self: Optic[Any, Any, Either[SetPiece, Piece2], GetError, SetError, Either[GetPiece, Piece2], SetWhole])

Provides implicit syntax for accessing the Left case of an Either accessed by a partially applied optic.

Provides implicit syntax for accessing the Left case of an Either accessed by a partially applied optic.

class LensSyntax[GetWhole, SetWholeBefore, SetPiece, GetError, SetError, GetPiece, SetWholeAfter](self: Optic[GetWhole, SetWholeBefore, SetPiece, GetError, SetError, GetPiece, SetWholeAfter])

Provides implicit syntax for when the whole is required to set.

Provides implicit syntax for when the whole is required to set.

class NonePartiallyAppliedSyntax[GetError >: OpticFailure, SetError, Piece, SetWhole](self: OpticPartiallyApplied[Option[Piece], GetError, SetError, Option[Piece], SetWhole])

Provides implicit syntax for accessing the None case of an Option accessed by a partially applied optic.

Provides implicit syntax for accessing the None case of an Option accessed by a partially applied optic.

class PariallyAppliedOpticSyntax[SetPiece, Error, GetPiece, SetWholeAfter](self: Optic[Any, Any, SetPiece, Error, Error, GetPiece, SetWholeAfter])

Provides implicit syntax for working with partially applied optics.

Provides implicit syntax for working with partially applied optics.

class PrismSyntax[GetWhole, SetPiece, GetError, SetError, GetPiece, SetWholeAfter](self: Optic[GetWhole, Any, SetPiece, GetError, SetError, GetPiece, SetWholeAfter])

Provides implicit syntax for when thewhole is not required to set.

Provides implicit syntax for when thewhole is not required to set.

class RightPartiallyAppliedSyntax[SetPiece, GetError >: OpticFailure, SetError, GetPiece, SetWhole, Piece2](self: OpticPartiallyApplied[Either[Piece2, SetPiece], GetError, SetError, Either[Piece2, GetPiece], SetWhole])

Provides implicit syntax for accessing the Right case of an Either accessed by a partially applied optic.

Provides implicit syntax for accessing the Right case of an Either accessed by a partially applied optic.

class SecondPartiallyAppliedSyntax[SetPiece, GetError, SetError >: GetError, GetPiece, Whole, Piece2](self: Optic[Any, Any, (Piece2, SetPiece), GetError, SetError, (Piece2, GetPiece), Whole])

Provides implicit syntax for accessing the second element of a tuple accessed by a partially applied optic.

Provides implicit syntax for accessing the second element of a tuple accessed by a partially applied optic.

class SlicePartiallyAppliedSyntax[GetError >: OpticFailure, SetError >: GetError, Piece, Whole](self: Optic[Any, Any, Chunk[Piece], GetError, SetError, Chunk[Piece], Whole])

Provides implicit syntax for accessing a slice of a chunk accessed by a partially applied optic.

Provides implicit syntax for accessing a slice of a chunk accessed by a partially applied optic.

class SomePartiallyAppliedSyntax[SetPiece, GetError >: OpticFailure, SetError, GetPiece, SetWhole](self: OpticPartiallyApplied[Option[SetPiece], GetError, SetError, Option[GetPiece], SetWhole])

Provides implicit syntax for accessing the Some case of an Option accessed by a partially applied optic.

Provides implicit syntax for accessing the Some case of an Option accessed by a partially applied optic.

class TailPartiallyAppliedSyntax[GetError >: OpticFailure, SetError >: GetError, Piece, Whole](self: Optic[Any, Any, List[Piece], GetError, SetError, List[Piece], Whole])

Provides implicit syntax for accessing the tail of a list accessed by a partially applied optic.

Provides implicit syntax for accessing the tail of a list accessed by a partially applied optic.

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from
Mirror

Value members

Concrete methods

def at[A](n: Int): Optional[Chunk[A], A]

An optic that accesses the specified index of a chunk.

An optic that accesses the specified index of a chunk.

def cons[A, B]: ZPrism[List[A], List[B], (A, List[A]), (B, List[B])]

An optic that accesses the :: case of a List.

An optic that accesses the :: case of a List.

def filter[A](f: A => Boolean): Traversal[Chunk[A], A]

An optic that accesses a filtered subset of a chunk.

An optic that accesses a filtered subset of a chunk.

def first[A, B, C]: ZLens[(A, B), (C, B), A, C]

An optic that accesses the first element of a tuple.

An optic that accesses the first element of a tuple.

def head[A]: Optional[List[A], A]

An optic that accesses the head of a list.

An optic that accesses the head of a list.

def identity[A]: Iso[A, A]

The identity optic.

The identity optic.

def key[K, V](k: K): Optional[Map[K, V], V]

An optic that accesses the value at the specified key in a map.

An optic that accesses the value at the specified key in a map.

def left[A, B, C]: ZPrism[Either[A, B], Either[C, B], A, C]

An optic that accesses the Left case of an Either.

An optic that accesses the Left case of an Either.

def none[A]: Prism[Option[A], Unit]

An optic that accesses the None case of an Option.

An optic that accesses the None case of an Option.

def right[A, B, C]: ZPrism[Either[A, B], Either[A, C], B, C]

An optic that accesses the Right case of an Either.

An optic that accesses the Right case of an Either.

def second[A, B, C]: ZLens[(A, B), (A, C), B, C]

An optic that accesses the second element of a tuple.

An optic that accesses the second element of a tuple.

def slice[A](from: Int, until: Int): Traversal[Chunk[A], A]

An optic that accesses a slice of a chunk.

An optic that accesses a slice of a chunk.

def some[A, B]: ZPrism[Option[A], Option[B], A, B]

An optic that accesses the Some case of an Option.

An optic that accesses the Some case of an Option.

def tail[A]: Optional[List[A], List[A]]

An optic that accesses the tail of a list.

An optic that accesses the tail of a list.