outcome/nz.adjmunro.outcome.result.members

Package-level declarations

Functions

inline fun <T> Iterable<KotlinResult<T>>.aggregate(reduce: (List<Throwable>) -> Throwable = { it.first() }): KotlinResult<List<T>>

andIf

inline fun <T> KotlinResult<T>.andIf(predicate: (T) -> Boolean, onSuccess: (T) -> T): KotlinResult<T>

If the predicate is true, transforms value inside a resultOf scope.

andThen

inline fun <In, Out> KotlinResult<In>.andThen(onSuccess: (In) -> Out): KotlinResult<Out>

Transforms value inside a resultOf scope.

andThenEach

inline fun <In, Out> Iterable<KotlinResult<In>>.andThenEach(success: (In) -> Out): List<KotlinResult<Out>>

Serial KotlinResult.andThen of multiple KotlinResults. Each result is processed in a separate coroutine, and the results are collected as a List of KotlinResult.

fun <In, Out> Sequence<KotlinResult<In>>.andThenEach(success: (In) -> Out): Sequence<KotlinResult<Out>>

Serial KotlinResult.andThen of multiple KotlinResults. Each result is processed in a separate coroutine, and the results are collected as a Sequence of KotlinResult.

exceptionOrDefault

fun <T> KotlinResult<T>.exceptionOrDefault(default: Throwable): Throwable

Try to get the exception of this Result.

exceptionOrElse

inline fun <T> KotlinResult<T>.exceptionOrElse(onSuccess: (T) -> Throwable): Throwable

Try to get the exception of this Result.

exceptionOrThrow

fun <T> KotlinResult<T>.exceptionOrThrow(): Throwable

Try to get the exception of this Result.

flatMap

inline fun <In, Out> KotlinResult<In>.flatMap(onSuccess: (In) -> KotlinResult<Out>): KotlinResult<Out>

Like Result.map, applies the onSuccess function to the encapsulated value.

flatten

fun <T> KotlinResult<KotlinResult<T>>.flatten(): KotlinResult<T>

Flattens a nested KotlinResult.

foldEach

inline fun <In, Out> Iterable<KotlinResult<In>>.foldEach(success: (In) -> Out, failure: (Throwable) -> Out): List<Out>

Serial KotlinResult.fold of multiple KotlinResults. Each result is processed in a separate coroutine, and the results are collected as a List of Out.

fun <In, Out> Sequence<KotlinResult<In>>.foldEach(success: (In) -> Out, failure: (Throwable) -> Out): Sequence<Out>

Serial KotlinResult.fold of multiple KotlinResults. Each result is processed in a separate coroutine, and the results are collected as a Sequence of Out.

mapFailure

inline fun <T> KotlinResult<T>.mapFailure(onFailure: (Throwable) -> Throwable): KotlinResult<T>

Transform exception into some other Throwable.

nullable

inline fun <T> nullable(block: () -> T): T?

Context runner that catches and normalises all non-fatal thrown exceptions into a null value.

nullable

inline fun <In, Out> In.nullable(block: In.() -> Out): Out?

Context runner that catches and normalises all non-fatal thrown exceptions into a null value.

resultOf

inline fun <T> resultOf(block: () -> T): KotlinResult<T>

Context runner to encapsulate the result of block as a nz.adjmunro.outcome.result.KotlinResult.

resultOf

inline fun <In, Out> In.resultOf(block: In.() -> Out): KotlinResult<Out>

Context runner to encapsulate the result of block as a KotlinResult.

resultOfEach

fun <T> resultOfEach(vararg blocks: () -> T): List<KotlinResult<T>>

Serial execution of multiple resultOf lambdas. Each lambda is executed in a separate coroutine, and the results are collected as a List of KotlinResult.

resultOfEach

fun <T> Iterable<() -> T>.resultOfEach(): List<KotlinResult<T>>

Serial execution of multiple resultOf lambdas. Each lambda is executed in a separate coroutine, and the results are collected as a List of KotlinResult.

fun <T> Sequence<() -> T>.resultOfEach(): Sequence<KotlinResult<T>>

Serial execution of multiple resultOf lambdas. Each lambda is executed in a separate coroutine, and the results are collected as a sequence of KotlinResult.

tryRecover

inline fun <T> KotlinResult<T>.tryRecover(onFailure: (Throwable) -> T): KotlinResult<T>

Transform exception into value.

tryRecoverEach

inline fun <T> Iterable<KotlinResult<T>>.tryRecoverEach(failure: (Throwable) -> T): List<KotlinResult<T>>

Serial KotlinResult.tryRecover of multiple KotlinResults. Each result is processed in a separate coroutine, and the results are collected as a List of KotlinResult.

fun <T> Sequence<KotlinResult<T>>.tryRecoverEach(failure: (Throwable) -> T): Sequence<KotlinResult<T>>

Serial KotlinResult.tryRecover of multiple KotlinResults. Each result is processed in a separate coroutine, and the results are collected as a Sequence of KotlinResult.