arrow-optics/arrow.optics/POptionalGetter

POptionalGetter

interface POptionalGetter<S, T, A> : Fold<S, A> (source)

An OptionalGetter is an optic that allows into a structure and querying an optional focus.

Parameters

the source of a POptional

the modified source of a POptional

the focus of a POptional

Types

Companion

object Companion

Functions

all

open fun all(source: S, predicate: (focus: A) -> Boolean): Boolean

Check if all targets satisfy the predicate

any

open fun any(source: S, predicate: (focus: A) -> Boolean): Boolean

Returns true if at least one focus matches the given predicate.

choice

open infix fun <C> choice(other: Fold<C, A>): Fold<Either<S, C>, A>

Join two Fold with the same target

open infix fun <S1, T1> choice(other: POptionalGetter<S1, T1, A>): POptionalGetter<Either<S, S1>, Either<T, T1>, A>

Join two POptionalGetter with the same focus

compose

open infix fun <C> compose(other: Fold<in A, out C>): Fold<S, C>

Compose a Fold with a Fold

open infix fun <C> compose(other: POptionalGetter<in A, T, out C>): POptionalGetter<S, T, C>

Compose a POptionalGetter with a POptionalGetter

exists

open fun exists(source: S, predicate: (focus: A) -> Boolean): Boolean

Check whether at least one element satisfies the predicate.

findOrNull

open fun findOrNull(source: S, predicate: (focus: A) -> Boolean): A?

Find the first element matching the predicate, if one exists.

first

open fun <C> first(): POptionalGetter<Pair<S, C>, Pair<T, C>, Pair<A, C>>

Create a product of the POptionalGetter and a type C

firstOrNull

open fun firstOrNull(source: S): A?

Get the first target or null

fold

open fun fold(M: Monoid<A>, source: S): A

Fold using the given Monoid instance.

foldMap

open override fun <R> foldMap(M: Monoid<R>, source: S, map: (focus: A) -> R): R

Map each target to a type R and use a Monoid to fold the results

getAll

open fun getAll(source: S): List<A>

Get all targets of the Fold

getOrModify

abstract fun getOrModify(source: S): Either<T, A>

Get the focus of an OptionalGetter or return the original value while allowing the type to change if it does not match

getOrNull

open fun getOrNull(source: S): A?

Get the focus of an OptionalGetter or null if the is not there

isEmpty

open fun isEmpty(source: S): Boolean

Check if there is no target

isNotEmpty

open fun isNotEmpty(source: S): Boolean

Check if there is at least one target

lastOrNull

open fun lastOrNull(source: S): A?

Get the last target or null

left

open fun <C> left(): Fold<Either<S, C>, Either<A, C>>

Create a sum of the Fold and a type C

plus

open operator fun <C> plus(other: Fold<in A, out C>): Fold<S, C>

open operator fun <C, D> plus(other: POptionalGetter<in A, T, out C>): POptionalGetter<S, T, C>

right

open fun <C> right(): Fold<Either<C, S>, Either<C, A>>

Create a sum of a type C and the Fold

second

open fun <C> second(): POptionalGetter<Pair<C, S>, Pair<C, T>, Pair<C, A>>

Create a product of a type C and the POptionalGetter

size

open fun size(source: S): Int

Calculate the number of targets

Inheritors

POptional

PPrism

Extensions

fun <T, S, I, A> Fold<T, S>.at(AT: At<S, I, A>, i: I): Fold<T, A>

DSL to compose At with a Fold for a structure S to focus in on A at given index I.

every

fun <T, S, A> Fold<T, S>.every(TR: Every<S, A>): Fold<T, A>

DSL to compose Traversal with a Fold for a structure S to see all its foci A

index

fun <T, S, I, A> Fold<T, S>.index(ID: Index<S, I, A>, i: I): Fold<T, A>

DSL to compose Index with a Fold for a structure S to focus in on A at given index I

some

val <T, S> Fold<T, Option<S>>.some: Fold<T, S>

DSL to compose a Prism with focus arrow.core.Some with a Fold with a focus of Option<S>