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.

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.

component1

open operator override fun component1(): Ok

component2

open operator fun component2(): Nothing?

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

falter

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

An alias for coerceToFailure.

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.

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>

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.

toString

open override fun toString(): String

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.