atrium-core/ch.tutteli.atrium.core

Package-level declarations

Contains Option and Either.

Types

sealed class Either<out L, out R>

Represents a disjoint union i.e. a type with two possibilities, either Left or Right.

data class Left<L>(val l: L) : Either<L, Nothing>

The left case of an Either.

Represents an absent value in terms of Option.

sealed class Option<out T>

Represents an optional value with map, flatMap, fold and getOrElse to transform it.

data class Right<R>(val r: R) : Either<Nothing, R>

The right case of an Either.

data class Some<T>(val value: T) : Option<T>

Represents a present value in terms of Option.

Returns false on calling.

Returns true on calling.

inline fun <L, R, T> Either<L, R>.flatMap(f: (R) -> Either<L, T>): Either<L, T>

flat-map over the Right side of this Either.

inline fun <T> Option<T>.getOrElse(default: () -> T): T

Get the value of this Option if defined or use the default-value provider.