arrow-optics/arrow.optics.dsl

Package-level declarations

Properties

Link copied to clipboard
@get:JvmName(name = "everyRight")
val <T, Error, A> Traversal<T, Either<Error, A>>.every: Traversal<T, A>
@get:JvmName(name = "everyNonEmptyList")
val <T, A> Traversal<T, NonEmptyList<A>>.every: Traversal<T, A>
@get:JvmName(name = "everySome")
val <T, A> Traversal<T, Option<A>>.every: Traversal<T, A>
@get:JvmName(name = "everyChar")
val <T> Traversal<T, String>.every: Traversal<T, Char>
val <T, A> Traversal<T, List<A>>.every: Traversal<T, A>
@get:JvmName(name = "everyValue")
val <T, K, V> Traversal<T, Map<K, V>>.every: Traversal<T, V>
@get:JvmName(name = "everySequence")
val <T, A> Traversal<T, Sequence<A>>.every: Traversal<T, A>
Link copied to clipboard
val <A, L, R> Optional<A, Either<L, R>>.left: Optional<A, L>

DSL to compose a Optional with focus Either with a Prism with a focus of Either.Left<L>

val <A, L, R> Prism<A, Either<L, R>>.left: Prism<A, L>

DSL to compose a Prism with focus Either with a Prism with a focus of Either.Left<L>

val <A, L, R> Traversal<A, Either<L, R>>.left: Traversal<A, L>

DSL to compose a Traversal with focus Either with a Prism with a focus of Either.Left<L>

Link copied to clipboard
val <T, S> Optional<T, S?>.notNull: Optional<T, S>

DSL to compose an Optional with focus on a nullable type with notNull.

val <T, S> Traversal<T, S?>.notNull: Traversal<T, S>

DSL to compose a Traversal with focus on a nullable type with notNull.

Link copied to clipboard
val <A, L, R> Optional<A, Either<L, R>>.right: Optional<A, R>

DSL to compose a Optional with focus Either with a Prism with a focus of Either.Right<R>

val <A, L, R> Prism<A, Either<L, R>>.right: Prism<A, R>

DSL to compose a Prism with focus Either with a Prism with a focus of Either.Right<R>

val <A, L, R> Traversal<A, Either<L, R>>.right: Traversal<A, R>

DSL to compose a Traversal with focus Either with a Prism with a focus of Either.Right<R>

Link copied to clipboard
val <T, S> Optional<T, Option<S>>.some: Optional<T, S>

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

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

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

Functions

Link copied to clipboard
fun <T, K, V> Lens<T, Map<K, V>>.at(key: K): Lens<T, Option<V>>
@JvmName(name = "atSet")
fun <T, A> Lens<T, Set<A>>.at(value: A): Lens<T, Boolean>
fun <T, K, V> Optional<T, Map<K, V>>.at(key: K): Optional<T, Option<V>>
@JvmName(name = "atSet")
fun <T, A> Optional<T, Set<A>>.at(value: A): Optional<T, Boolean>
fun <T, K, V> Traversal<T, Map<K, V>>.at(key: K): Traversal<T, Option<V>>
@JvmName(name = "atSet")
fun <T, A> Traversal<T, Set<A>>.at(value: A): Traversal<T, Boolean>

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

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

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

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

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

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

Link copied to clipboard
fun <T, S, A> Traversal<T, S>.every(tr: Traversal<S, A>): Traversal<T, A>

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

Link copied to clipboard
fun <S, A> Optional<S, A>.filter(predicate: (A) -> Boolean): Optional<S, A>

Focuses on the value only if the predicate is true.

fun <S, A> Traversal<S, A>.filter(predicate: (A) -> Boolean): Traversal<S, A>

Focuses on those values for which the predicate is true.

Link copied to clipboard
@JvmName(name = "filterNonEmptyList")
fun <T, A> Traversal<T, NonEmptyList<A>>.filterIndex(predicate: Predicate<Int>): Traversal<T, A>
@JvmName(name = "filterChars")
fun <T> Traversal<T, String>.filterIndex(predicate: Predicate<Int>): Traversal<T, Char>
fun <T, A> Traversal<T, List<A>>.filterIndex(predicate: Predicate<Int>): Traversal<T, A>
@JvmName(name = "filterValues")
fun <T, K, A> Traversal<T, Map<K, A>>.filterIndex(predicate: Predicate<K>): Traversal<T, A>
@JvmName(name = "filterSequence")
fun <T, A> Traversal<T, Sequence<A>>.filterIndex(predicate: Predicate<Int>): Traversal<T, A>

fun <T, S, I, A> Traversal<T, S>.filterIndex(filter: FilterIndex<S, I, A>, predicate: Predicate<I>): Traversal<T, A>

DSL to compose FilterIndex with an Traversal for a structure S to focus in on A at given index I

Link copied to clipboard
@JvmName(name = "indexNonEmptyList")
fun <T, A> Optional<T, NonEmptyList<A>>.index(index: Int): Optional<T, A>
@JvmName(name = "indexString")
fun <T> Optional<T, String>.index(index: Int): Optional<T, Char>
fun <T, A> Optional<T, List<A>>.index(index: Int): Optional<T, A>
@JvmName(name = "indexValues")
fun <T, K, A> Optional<T, Map<K, A>>.index(key: K): Optional<T, A>
@JvmName(name = "indexSequence")
fun <T, A> Optional<T, Sequence<A>>.index(index: Int): Optional<T, A>
@JvmName(name = "indexNonEmptyList")
fun <T, A> Traversal<T, NonEmptyList<A>>.index(index: Int): Traversal<T, A>
@JvmName(name = "indexString")
fun <T> Traversal<T, String>.index(index: Int): Traversal<T, Char>
fun <T, A> Traversal<T, List<A>>.index(index: Int): Traversal<T, A>
@JvmName(name = "indexValues")
fun <T, K, A> Traversal<T, Map<K, A>>.index(key: K): Traversal<T, A>
@JvmName(name = "indexSequence")
fun <T, A> Traversal<T, Sequence<A>>.index(index: Int): Traversal<T, A>

fun <T, S, I, A> Optional<T, S>.index(idx: Index<S, I, A>, i: I): Optional<T, A>

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

fun <T, S, I, A> Traversal<T, S>.index(idx: Index<S, I, A>, i: I): Traversal<T, A>

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