Transforms the encapsulated value if this instance represents success, and the predicate returns true. If predicate is false, the Success is left unchanged.

andThen

inline fun <In : Any, Out : Any, Error : Any> Outcome<In, Error>.andThen(catch: (throwable: Throwable) -> Outcome<Out, Error> = ::rethrow, success: RaiseScope<Error>.(In) -> Out): Outcome<Out, Error>

Transforms the encapsulated value if this instance represents success.

catch

inline fun <Ok : Any> catch(block: RaiseScope<Throwable>.() -> Ok): Outcome<Ok, Throwable>

An alias for outcomeOf that uses Throwable as the Error type.

catch

inline fun <In, Out : Any> In.catch(block: RaiseScope<Throwable>.(In) -> Out): Outcome<Out, Throwable>

An alias for outcomeOf that uses Throwable as the Error type.

coerceToFailure

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.coerceToFailure(falter: (Ok) -> Error): Failure<Error>

Returns a new Failure, after applying falter to the Success value.

coerceToSuccess

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.coerceToSuccess(recover: (Error) -> Ok): Success<Ok>

Returns a new Success, after applying recover to the Failure error.

collapse

fun <Ancestor : Any, Ok : Ancestor, Error : Ancestor> Outcome<Ok, Error>.collapse(): Ancestor

Collapse the receiver Outcome into either value or error, using the nearest common Ancestor as the type.

emptyFailure

inline fun emptyFailure(ignore: Any? = null): Failure<Unit>

An inline hack to produce a Failure outcome with no error.

emptySuccess

inline fun emptySuccess(ignore: Any? = null): Success<Unit>

An inline hack to produce a Success outcome with no value.

errorOrDefault

infix fun <Ok : Any, Error : Any> Outcome<Ok, Error>.errorOrDefault(default: Error): Error

errorOrElse

infix inline fun <Ok : Any, Error> Outcome<Ok, Error & Any>.errorOrElse(faulter: (Ok) -> Error): Error

errorOrNull

fun <Ok : Any, Error : Any> Outcome<Ok, Error>.errorOrNull(): Error?

errorOrThrow

fun <Ok : Any, Error : Any> Outcome<Ok, Error>.errorOrThrow(): Error

failureOf

inline fun <Error : Any> failureOf(block: () -> Error): Failure<Error>

Builds a Failure outcome with the error provided by the block.

failureOf

inline fun <In, Out : Any, Error : Any> In.failureOf(block: (In) -> Error): Failure<Error>

Builds a Failure outcome with the error provided by the block.

falter

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.falter(transform: (Ok) -> Error): Failure<Error>

An alias for coerceToFailure.

faulty

inline fun <T : Any> T.faulty(isFailure: T.() -> Boolean): Faulty<T>

Wraps a value of type T as a Faulty based on a isFailure.

faultyOf

inline fun <Error : Any> faultyOf(catch: (throwable: Throwable) -> Faulty<Error> = ::rethrow, block: RaiseScope<Error>.() -> Unit): Faulty<Error>

Context runner that encapsulates the result of block as a Faulty.

faultyOf

inline fun <In, Error : Any> In.faultyOf(catch: (throwable: Throwable) -> Faulty<Error> = ::rethrow, block: RaiseScope<Error>.(In) -> Unit): Faulty<Error>

Context runner that encapsulates the result of block as a Faulty.

flatMapFailure

infix inline fun <Ok : Any, ErrorIn : Any, ErrorOut : Any> Outcome<Ok, ErrorIn>.flatMapFailure(transform: (ErrorIn) -> Outcome<Ok, ErrorOut>): Outcome<Ok, ErrorOut>

Returns a new Outcome, after applying transform to the Failure error.

flatMapSuccess

infix inline fun <In : Any, Out : Any, Error : Any> Outcome<In, Error>.flatMapSuccess(transform: (In) -> Outcome<Out, Error>): Outcome<Out, Error>

Returns a new Outcome, after applying transform to the Success value.

flattenNestedBoth

Flatten the nested Outcome inside both Success and Failure states, into a single Outcome.

flattenNestedFailure

fun <OuterOk : AncestorOk, EmbeddedOk : AncestorOk, Error : Any, AncestorOk : Any> Outcome<OuterOk, Outcome<EmbeddedOk, Error>>.flattenNestedFailure(): Outcome<AncestorOk, Error>

Flatten a nested Outcome inside the Failure state, into a single Outcome.

flattenNestedSuccess

fun <Ok : Any, EmbeddedError : AncestorError, OuterError : AncestorError, AncestorError : Any> Outcome<Outcome<Ok, EmbeddedError>, OuterError>.flattenNestedSuccess(): Outcome<Ok, AncestorError>

Flatten a nested Outcome inside the Success state, into a single Outcome.

fold

inline fun <Ok : Any, Error : Any, Output> Outcome<Ok, Error>.fold(failure: Failure<Error>.() -> Output, success: Success<Ok>.() -> Output): Output

Fold the caller into some Output.

getOrDefault

infix fun <Ok : Any, Error : Any> Outcome<Ok, Error>.getOrDefault(default: Ok): Ok

getOrElse

infix inline fun <Ok, Error : Any> Outcome<Ok & Any, Error>.getOrElse(recover: (Error) -> Ok): Ok

getOrNull

fun <Ok : Any, Error : Any> Outcome<Ok, Error>.getOrNull(): Ok?

getOrThrow

fun <Ok : Any, Error : Any> Outcome<Ok, Error>.getOrThrow(): Ok

invert

fun <Ok : Any, Error : Any> Outcome<Ok, Error>.invert(): Outcome<Error, Ok>

Inverts the Outcome so that the Success value becomes the Failure error and vice versa.

isFailure

fun <Ok : Any, Error : Any> Outcome<Ok, Error>.isFailure(): Boolean

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.isFailure(predicate: (Error) -> Boolean): Boolean

isSuccess

fun <Ok : Any, Error : Any> Outcome<Ok, Error>.isSuccess(): Boolean

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.isSuccess(predicate: (Ok) -> Boolean): Boolean

map

inline fun <In : Any, Out : Any, ErrorIn : Any, ErrorOut : Any> Outcome<In, ErrorIn>.map(failure: (ErrorIn) -> ErrorOut, success: (In) -> Out): Outcome<Out, ErrorOut>

Transform an Outcome with either success or failure.

mapFailure

infix inline fun <Ok : Any, ErrorIn : Any, ErrorOut : Any> Outcome<Ok, ErrorIn>.mapFailure(transform: (ErrorIn) -> ErrorOut): Outcome<Ok, ErrorOut>

Returns a new Outcome, after applying transform to the Failure error.

mapSuccess

infix inline fun <In : Any, Out : Any, Error : Any> Outcome<In, Error>.mapSuccess(transform: (In) -> Out): Outcome<Out, Error>

Returns a new Outcome, after applying transform to the Success value.

maybe

inline fun <Ok : Any> Ok.maybe(isSuccess: Ok.() -> Boolean): Maybe<Ok>

Wraps a value of type Ok as a Maybe based on a isSuccess.

maybeOf

inline fun <Ok : Any> maybeOf(catch: (throwable: Throwable) -> Maybe<Ok> = ::emptyFailure, block: RaiseScope<Unit>.() -> Ok): Maybe<Ok>

Context runner that encapsulates the result of block as a Maybe.

maybeOf

inline fun <In, Out : Any> In.maybeOf(catch: (throwable: Throwable) -> Maybe<Out> = ::rethrow, block: RaiseScope<Unit>.(In) -> Out): Maybe<Out>

Context runner that encapsulates the result of block as a Maybe.

nullableOf

inline fun <T : Any> nullableOf(block: RaiseScope<Unit>.() -> T): T?

Context runner that uses RaiseScope to safely capture raised or thrown errors, and unwraps either the successful Outcome or null.

nullableOf

inline fun <In, Out : Any> In.nullableOf(block: RaiseScope<Unit>.(In) -> Out): Out?

Context runner that uses RaiseScope to safely capture raised or thrown errors, and unwraps either the successful Outcome or null.

onFailure

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.onFailure(block: (Error) -> Unit): Outcome<Ok, Error>

onSuccess

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.onSuccess(block: (Ok) -> Unit): Outcome<Ok, Error>

outcome

inline fun <Ok : Any> outcome(block: RaiseScope<String>.() -> Ok): Outcome<Ok, String>

An alias for outcomeOf that uses a String as the Error type.

outcome

inline fun <In, Out : Any> In.outcome(block: RaiseScope<String>.(In) -> Out): Outcome<Out, String>

An alias for outcomeOf that uses a String as the Error type.

fun <Ok : Any, Error : Any> Ok.outcome(predicate: Ok.() -> Boolean, faulter: Ok.() -> Error): Outcome<Ok, Error>

Wraps a value of type Ok as an Outcome based on a predicate.

outcomeOf

inline fun <Ok : Any, Error : Any> outcomeOf(catch: (throwable: Throwable) -> Outcome<Ok, Error> = ::rethrow, block: RaiseScope<Error>.() -> Ok): Outcome<Ok, Error>

Context runner that encapsulates the Ok result of block as an Success, and any raised or caught errors as an Failure.

outcomeOf

inline fun <In, Out : Any, Error : Any> In.outcomeOf(catch: (throwable: Throwable) -> Outcome<Out, Error> = ::rethrow, block: RaiseScope<Error>.(In) -> Out): Outcome<Out, Error>

Context runner that encapsulates the result of block as an Success, and any raised or caught errors as an Failure.

recover

infix inline fun <Ok : Any, Error : Any> Outcome<Ok, Error>.recover(transform: (Error) -> Ok): Success<Ok>

An alias for coerceToSuccess.

rfold

inline fun <Ok : Any, Error : Any, Output> Outcome<Ok, Error>.rfold(success: Success<Ok>.() -> Output, failure: Failure<Error>.() -> Output): Output

Reverse fold is syntax-sugar that swaps the lambda argument order.

safely

inline fun <T : Any> safely(crossinline fallback: (Any) -> T, block: RaiseScope<Unit>.() -> T): T

Context runner that uses RaiseScope to safely capture raised or thrown errors, and unwraps either the successful Outcome or the fallback, returning T.

safely

inline fun <In, Out : Any> In.safely(crossinline fallback: (Any) -> Out, block: RaiseScope<Unit>.(In) -> Out): Out

Context runner that uses RaiseScope to safely capture raised or thrown errors, and unwraps either the successful Outcome or the fallback, returning Out.

successOf

inline fun <Ok : Any> successOf(block: () -> Ok): Success<Ok>

Builds a Success outcome with the value provided by the block.

successOf

inline fun <In, Out : Any> In.successOf(block: (In) -> Out): Success<Out>

Builds a Success outcome with the value provided by the block.

tryRecover

inline fun <Ok : Any, ErrorIn : Any, ErrorOut : Any> Outcome<Ok, ErrorIn>.tryRecover(catch: (throwable: Throwable) -> Outcome<Ok, ErrorOut> = ::rethrow, failure: RaiseScope<ErrorOut>.(ErrorIn) -> Ok): Outcome<Ok, ErrorOut>

Transform failure into success.