Package-level declarations

Types

interface Copy<A>

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "Delicate optic, please check the documentation for correct usage.")

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class DelicateOptic

Every

object Every

Iso

typealias Iso<S, A> = PIso<S, S, A, A>

Iso is a type alias for PIso which fixes the type arguments and restricts the PIso to monomorphic updates.

Lens

typealias Lens<S, A> = PLens<S, S, A, A>

Lens is a type alias for PLens which fixes the type arguments and restricts the PLens to monomorphic updates.

OpticsCopyMarker

@DslMarker

annotation class OpticsCopyMarker

Optional

typealias Optional<S, A> = POptional<S, S, A, A>

Optional is a type alias for POptional which fixes the type arguments and restricts the POptional to monomorphic updates.

PIso

interface PIso<S, T, A, B> : PPrism<S, T, A, B> , PLens<S, T, A, B>

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 TupleN

PLens

interface PLens<S, T, A, B> : POptional<S, T, A, B>

A Lens (or Functional Reference) is an optic that can focus into a structure for getting, setting or modifying the focus (target).

POptional

interface POptional<S, T, A, B> : PTraversal<S, T, A, B>

Optional is an optic that allows to focus into a structure and querying or copy'ing an optional focus.

PPrism

interface PPrism<S, T, A, B> : POptional<S, T, A, B>

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

Prism

typealias Prism<S, A> = PPrism<S, S, A, A>

Prism is a type alias for PPrism which fixes the type arguments and restricts the PPrism to monomorphic updates.

PTraversal

interface PTraversal<S, T, A, B>

A Traversal is an optic that allows to see into a structure with 0 to N foci.

Traversal

typealias Traversal<S, A> = PTraversal<S, S, A, A>

Traversal is a type alias for PTraversal which fixes the type arguments and restricts the PTraversal to monomorphic updates.

Functions

composeNull

infix fun <S, T, A, B, C, D> PLens<S, T, A?, B?>.composeNull(other: PLens<A, B, C, D>): PLens<S, T, C?, D?>

Compose two lenses, where the first one has a nullable focus, keeping the nullability in the types.

cons

infix fun <A> A.cons(tail: List<A>): List<A>

copy

fun <A> A.copy(f: Copy<A>.() -> Unit): A

Small DSL which parallel Kotlin's built-in copy, but using optics instead of field names. See Copy for the operations allowed inside the block.

filter

fun <S> POptional.Companion.filter(predicate: (S) -> Boolean): Optional<S, S>

Focuses on the value only if the predicate is true. This optics The optic is perfectly OK when used to get values using getOrNull or getAll; but requires some caution using modify with it.

fromLenses

fun <S, A, B> PTraversal.Companion.fromLenses(lens1: PLens<S, S, A, B>, vararg lenses: PLens<S, S, A, B>): PTraversal<S, S, A, B>

Focuses on a sequence of lenses.

get

operator fun <A, T> PLens<T, T, List<A>, List<A>>.get(i: Int): POptional<T, T, A, A>

Optional

fun <S, A> Optional(getOption: (source: S) -> Option<A>, set: (source: S, focus: A) -> S): Optional<S, A>

Prism

fun <S, A> Prism(getOption: (source: S) -> Option<A>, reverseGet: (focus: A) -> S): Prism<S, A>

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 Prism

set

context(copy: Copy<A>)
infix fun <A, B> Traversal<A, B>.set(b: B)

Changes the value of the element(s) pointed by the Traversal.

snoc

infix fun <A> List<A>.snoc(last: A): List<A>

transform

context(copy: Copy<A>)
infix fun <A, B> Traversal<A, B>.transform(f: (B) -> B)

Transforms the value of the element(s) pointed by the Traversal.

uncons

fun <A> List<A>.uncons(): Pair<A, List<A>>?

unsnoc

fun <A> List<A>.unsnoc(): Pair<List<A>, A>?