Returns the $option's value if this option is nonempty '''and''' the predicate $p returns true when applied to this $option's value. Otherwise, returns null.

flatMap

inline fun flatMap(f: (T) -> Option): Option

Returns the result of applying $f to this $option's value if this $option is nonempty. Returns $none if this $option is empty. Slightly different from map in that $f is expected to return an $option (which could be $none).

fold

inline fun <R> fold(ifEmpty: () -> R, ifSome: (T) -> R): R

foldLeft

inline fun foldLeft(initial: B, operation: (B, T) -> B): B

foldMap

inline fun foldMap(MB: Monoid, f: (T) -> B): B

isDefined

fun isDefined(): Boolean

Returns true if the option is an instance of Some, false otherwise.

isEmpty

open override fun isEmpty(): Boolean

Returns true if the option is None, false otherwise.

isNotEmpty

fun isNotEmpty(): Boolean

map

inline fun map(f: (T) -> B): Option

Returns a Some<$B> containing the result of applying $f to this $option's value if this $option is nonempty. Otherwise return $none.

mapNotNull

inline fun mapNotNull(f: (T) -> B?): Option

Returns $none if the result of applying $f to this $option's value is null. Otherwise returns the result.

nonEmpty

fun nonEmpty(): Boolean

alias for isDefined

orNull

fun orNull(): T?

padZip

fun padZip(other: Option): Option<Pair<T?, B?>>

inline fun <B, C> padZip(other: Option, f: (T?, B?) -> C): Option<C>

pairLeft

fun <L> pairLeft(left: L): Option<Pair<L, T>>

pairRight

fun <R> pairRight(right: R): Option<Pair<T, R>>

reduceOrNull

inline fun reduceOrNull(initial: (T) -> B, operation: (B, T) -> B): B?

reduceRightEvalOrNull

inline fun reduceRightEvalOrNull(initial: (T) -> B, operation: (T, acc: Eval) -> Eval): Eval<B?>

replicate

fun replicate(n: Int): Option<List<T>>

tap

inline fun tap(f: (T) -> Unit): Option<T>

The given function is applied as a fire and forget effect if this is a some. When applied the result is ignored and the original Some value is returned

tapNone

inline fun tapNone(f: () -> Unit): Option<T>

The given function is applied as a fire and forget effect if this is a None. When applied the result is ignored and the original None value is returned

toEither

inline fun <L> toEither(ifEmpty: () -> L): Either<L, T>

toList

fun toList(): List<T>

toString

open override fun toString(): String

traverse

inline fun traverse(fa: (T) -> Iterable): List<Option>

traverseEither

inline fun <AA, B> traverseEither(fa: (T) -> Either<AA, B>): Either<AA, Option>

traverseValidated

inline fun <AA, B> traverseValidated(fa: (T) -> Validated<AA, B>): Validated<AA, Option>

void

fun void(): Option<Unit>

zip

fun zip(other: Option): Option<Pair<T, B>>

inline fun <B, C> zip(b: Option, map: (T, B) -> C): Option<C>

inline fun <B, C, D> zip(b: Option, c: Option<C>, map: (T, B, C) -> D): Option<D>

inline fun <B, C, D, E> zip(b: Option, c: Option<C>, d: Option<D>, map: (T, B, C, D) -> E): Option<E>

inline fun <B, C, D, E, F> zip(b: Option, c: Option<C>, d: Option<D>, e: Option<E>, map: (T, B, C, D, E) -> F): Option<F>

inline fun <B, C, D, E, F, G> zip(b: Option, c: Option<C>, d: Option<D>, e: Option<E>, f: Option<F>, map: (T, B, C, D, E, F) -> G): Option<G>

inline fun <B, C, D, E, F, G, H> zip(b: Option, c: Option<C>, d: Option<D>, e: Option<E>, f: Option<F>, g: Option<G>, map: (T, B, C, D, E, F, G) -> H): Option<H>

inline fun <B, C, D, E, F, G, H, I> zip(b: Option, c: Option<C>, d: Option<D>, e: Option<E>, f: Option<F>, g: Option<G>, h: Option<H>, map: (T, B, C, D, E, F, G, H) -> I): Option

inline fun <B, C, D, E, F, G, H, I, J> zip(b: Option, c: Option<C>, d: Option<D>, e: Option<E>, f: Option<F>, g: Option<G>, h: Option<H>, i: Option, map: (T, B, C, D, E, F, G, H, I) -> J): Option<J>

inline fun <B, C, D, E, F, G, H, I, J, K> zip(b: Option, c: Option<C>, d: Option<D>, e: Option<E>, f: Option<F>, g: Option<G>, h: Option<H>, i: Option, j: Option<J>, map: (T, B, C, D, E, F, G, H, I, J) -> K): Option<K>

Properties

value

val value: T