3.1.1

State/opensavvy.state.outcome

Package-level declarations

Utilities for the Outcome type, allowing to embed typed error management directly into the API without using exceptions.

Types

sealed class Outcome<out Failure, out Value>

The result of an operation.

Properties

val <Failure> Outcome<Failure, Nothing>.failure: Failure

Returns Failure.failure.

val <Failure : Any> Outcome<Failure, *>.failureOrNull: Failure?

Returns Failure.failure, or null if this outcome is not a failure.

val <Value> Outcome<Nothing, Value>.value: Value

Returns Success.value.

val <Value : Any> Outcome<*, Value>.valueOrNull: Value?

Returns Success.value, or null if this outcome is not successful.

Functions

fun <Failure> Failure.failed(): Outcome.Failure<Failure>

inline fun <Failure, InputValue, OutputValue> Outcome<Failure, InputValue>.map(transform: (InputValue) -> OutputValue): Outcome<Failure, OutputValue>

If this outcome is successful, replaces its value using transform.

inline fun <InputFailure, Value, OutputFailure> Outcome<InputFailure, Value>.mapFailure(transformFailure: (InputFailure) -> OutputFailure): Outcome<OutputFailure, Value>

If this outcome is failed, replaces its failure using transformFailure.

inline fun <Failure> Outcome<Failure, *>.onFailure(block: (Failure) -> Unit)

Executes block if this outcome is a failure.

inline fun <Value> Outcome<*, Value>.onSuccess(block: (Value) -> Unit)

Executes block if this outcome is successful.

fun <Value> Value.successful(): Outcome.Success<Value>