Failure

data class Failure<Failure>(val failure: Failure) : Outcome<Failure, Nothing> 

The latest known result of the operation was a failure, available as failure.

Constructors

Failure

constructor(failure: Failure)

Properties

failure

val failure: Failure

failure

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

Returns Failure.failure.

failureOrNull

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

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

value

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

Returns Success.value.

valueOrNull

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

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

Functions

map

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.

If this outcome isn't successful, does nothing.

See also

• mapFailure: Map the failure state instead of the success state.

mapFailure

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.

If this outcome isn't failed, does nothing.

See also

• map: Map the success state instead of the failure state.

onFailure

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

Executes block if this outcome is a failure.

Otherwise, does nothing.

onSuccess

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

Executes block if this outcome is successful.

Otherwise, does nothing.

toEither

fun <Failure, Value> Outcome<Failure, Value>.toEither(): Either<Failure, Value>

Converts an Outcome into a typed Either.

withProgress

fun <Failure, Value> Outcome<Failure, Value>.withProgress(progress: Progress = done()): ProgressiveOutcome<Failure, Value>

Adds progress information to this outcome to make it a ProgressiveOutcome.