Failure

data class Failure<Error, Value>(error: Error) : Result<Error, Value>

A failed result of a computation

Parameters

error

the problem that occurred

Constructors

Failure

fun <Error> Failure(error: Error)

the problem that occurred

Functions

andThen

fun <T> andThen(chain: (Value) -> Result<Error, T>): Result<Error, T>

Chain two computations togetherIf in a computation chain the result of one computation is needed as input for another computation, andThen is there to chain the computations together.

andThenError

fun <T> andThenError(chain: (Error) -> Result<T, Value>): Result<T, Value>

Chain two computations together for error recovery.

component1

operator fun component1(): Error

copy

fun copy(error: Error): Failure<Error, Value>

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

map

fun <T> map(transform: (Value) -> T): Result<Error, T>

Transform a successful result.

mapError

fun <T> mapError(transform: (Error) -> T): Result<T, Value>

Transform a failed result.

orThrowException

fun orThrowException(exceptionProducer: (Error) -> Exception): Value

Unwrap the result by throwing an Exception that can depend on the kind of failureif a computation was a Success, return that data.

toString

open override fun toString(): String

use

fun use(actOn: (Value) -> Unit): Result<Error, Value>

Use the data of a successful result.

useError

fun useError(actOn: (Error) -> Unit): Result<Error, Value>

Use the error of a failed result.

withDefault

fun withDefault(defaultValue: Value): Value

Unwrap the result by providing a default value.

fun withDefault(producer: (Error) -> Value): Value

Unwrap the result by providing a default value that can depend on the kind of failure.

Properties

error

val error: Error

the problem that occurred

Failure

See also

Parameters

Constructors

Functions

Properties