arrow-optics / arrow.optics

Package arrow.optics

Types

Fold A Fold is an optic that allows to focus into structure and get multiple results.interface Fold<S, A>
ForIso typealias ForIso = <ERROR CLASS>
ForLens typealias ForLens = <ERROR CLASS>
ForOptional typealias ForOptional = <ERROR CLASS>
ForPrism typealias ForPrism = <ERROR CLASS>
ForSetter typealias ForSetter = <ERROR CLASS>
ForTraversal typealias ForTraversal = <ERROR CLASS>
Getter A Getter is an optic that allows to see into a structure and getting a focus.interface Getter<S, A>
Iso Iso is a type alias for PIso which fixes the type arguments and restricts the PIso to monomorphic updates.typealias Iso<S, A> = PIso<S, S, A, A>
IsoKindedJ typealias IsoKindedJ<S, A> = <ERROR CLASS><S, S, A, A>
IsoOf typealias IsoOf<S, A> = <ERROR CLASS><S, S, A, A>
IsoPartialOf typealias IsoPartialOf<S> = Kind<ForIso, S>
Lens Lens is a type alias for PLens which fixes the type arguments and restricts the PLens to monomorphic updates.typealias Lens<S, A> = PLens<S, S, A, A>
LensKindedJ typealias LensKindedJ<S, A> = <ERROR CLASS><S, S, A, A>
LensOf typealias LensOf<S, A> = <ERROR CLASS><S, S, A, A>
LensPartialOf typealias LensPartialOf<S> = Kind<ForLens, S>
Optional Optional is a type alias for POptional which fixes the type arguments and restricts the POptional to monomorphic updates.typealias Optional<S, A> = POptional<S, S, A, A>
OptionalKindedJ typealias OptionalKindedJ<S, A> = <ERROR CLASS><S, S, A, A>
OptionalOf typealias OptionalOf<S, A> = <ERROR CLASS><S, S, A, A>
OptionalPartialOf typealias OptionalPartialOf<S> = Kind<ForOptional, S>
PIso An Iso is a loss less invertible optic that defines an isomorphism between a type S and A i.e. a data class and its properties represented by TupleNinterface PIso<S, T, A, B>
PLens A Lens (or Functional Reference) is an optic that can focus into a structure for getting, setting or modifying the focus (target).interface PLens<S, T, A, B>
POptional Optional is an optic that allows to focus into a structure and querying or copy‘ing an optional focus.interface POptional<S, T, A, B>
PPrism A Prism is a loss less invertible optic that can look into a structure and optionally find its focus. Mostly used for finding a focus that is only present under certain conditions i.e. list head Prism<List, Int>interface PPrism<S, T, A, B>
Prism Prism is a type alias for PPrism which fixes the type arguments and restricts the PPrism to monomorphic updates.typealias Prism<S, A> = PPrism<S, S, A, A>
PrismKindedJ typealias PrismKindedJ<S, A> = <ERROR CLASS><S, S, A, A>
PrismOf typealias PrismOf<S, A> = <ERROR CLASS><S, S, A, A>
PrismPartialOf typealias PrismPartialOf<S> = Kind<ForPrism, S>
PSetter A Setter is an optic that allows to see into a structure and set or modify its focus.interface PSetter<S, T, A, B>
PTraversal A Traversal is an optic that allows to see into a structure with 0 to N foci.interface PTraversal<S, T, A, B>
Setter Setter is a type alias for PSetter which fixes the type arguments and restricts the PSetter to monomorphic updates.typealias Setter<S, A> = PSetter<S, S, A, A>
SetterKindedJ typealias SetterKindedJ<S, A> = <ERROR CLASS><S, S, A, A>
SetterOf typealias SetterOf<S, A> = <ERROR CLASS><S, S, A, A>
SetterPartialOf typealias SetterPartialOf<S> = Kind<ForSetter, S>
Traversal Traversal is a type alias for PTraversal which fixes the type arguments and restricts the PTraversal to monomorphic updates.typealias Traversal<S, A> = PTraversal<S, S, A, A>
TraversalKindedJ typealias TraversalKindedJ<S, A> = <ERROR CLASS><S, S, A, A>
TraversalOf typealias TraversalOf<S, A> = <ERROR CLASS><S, S, A, A>
TraversalPartialOf typealias TraversalPartialOf<S> = Kind<ForTraversal, S>

Extensions for External Classes

arrow.core.Either  
arrow.core.Id  
arrow.core.ListExtensions  
arrow.core.ListK  
arrow.core.MapK  
arrow.core.NonEmptyList  
arrow.core.Option  
arrow.core.SetExtensions  
arrow.core.Try  
arrow.core.Tuple10  
arrow.core.Tuple2  
arrow.core.Tuple3  
arrow.core.Tuple4  
arrow.core.Tuple5  
arrow.core.Tuple6  
arrow.core.Tuple7  
arrow.core.Tuple8  
arrow.core.Tuple9  
arrow.core.Validated  
kotlin.String  

Functions

Optional fun <S, A> Optional(getOption: (source: S) -> Option<A>, set: (source: S, focus: A) -> S): Optional<S, A>
Prism Invoke operator overload to create a PPrism of type S with a focus A where A is a subtype of S Can also be used to construct Prismfun <S, A> Prism(getOption: (S) -> Option<A>, reverseGet: (A) -> S): Prism<S, A>

Do you like Arrow?

Arrow Org
<