Utilities/mtctx.utilities/Outcome/Failure

Failure

data class Failure(val message: String, val throwable: Throwable? = null, val outcome: Outcome<*>? = null) : Outcome<Nothing>

Represents a failed outcome with an error message and optional cause.

Parameters

message

A description of the failure.

throwable

An optional Throwable that caused the failure.

outcome

An optional nested Outcome for chained failures.

Constructors

Failure

constructor(message: String, throwable: Throwable? = null, outcome: Outcome<*>? = null)

Properties

failed

open val failed: Boolean

Indicates whether the operation failed (opposite of succeeded).

message

val message: String

outcome

val outcome: Outcome<*>?

succeeded

open override val succeeded: Boolean

Indicates whether the operation succeeded.

throwable

val throwable: Throwable?

Functions

exceptionOrNull

open fun exceptionOrNull(): Throwable?

Returns the Throwable of a Failure or null if the outcome is a Success.

flatMap

inline suspend fun <T, R> Outcome<T>.flatMap(transform: suspend (T) -> Outcome<R>): Outcome<R>

Flat-maps the value of a successful Outcome using the provided transform function.

fold

inline suspend fun <T, R> Outcome<T>.fold(onSuccess: suspend (T) -> R, onFailure: suspend (String, Throwable?) -> R): R

Folds the Outcome into a single value by applying onSuccess for a Success or onFailure for a Failure.

getOrNull

open fun getOrNull(): Nothing?

Returns the value of a Success or null if the outcome is a Failure.

map

inline suspend fun <T, R> Outcome<T>.map(transform: suspend (T) -> R): Outcome<R>

Maps the value of a successful Outcome using the provided transform function.

mapCatching

inline suspend fun <T, R> Outcome<T>.mapCatching(transform: suspend (T) -> R): Outcome<R>

Maps the value of a successful Outcome using the provided transform function, catching any exceptions.

mapFailure

inline suspend fun <T> Outcome<T>.mapFailure(transform: suspend (Outcome.Failure) -> Outcome.Failure): Outcome<T>

Maps a Failure using the provided transform function, leaving Success unchanged.

recover

inline suspend fun <T> Outcome<T>.recover(recoverBlock: suspend (Outcome.Failure) -> T): Outcome<T>

Recovers from a Failure by applying the recoverBlock function to produce a new value.

recoverCatching

inline suspend fun <T> Outcome<T>.recoverCatching(recoverBlock: suspend (Outcome.Failure) -> T): Outcome<T>

Recovers from a Failure by applying the recoverBlock function, catching any exceptions.

toResult

open fun toResult(): Result<Nothing>

Converts this Outcome to a Result.

toString

open override fun toString(): String

Returns a string representation of this Failure instance.

toStringWithStackTrace

fun toStringWithStackTrace(): String

Returns a string representation of this Failure instance with stack trace details.