kresult-core/io.kresult.core/KResult/Failure

Failure

class Failure<out E>(val error: E) : KResult<E, Nothing> , KResult.HasError<E> (source)

Represents a failed KResult

Constructors

Failure

constructor(error: E)

Properties

error

open override val error: E

Functions

asResult

fun <E : Throwable, T> KResult<E, T>.asResult(): Result<T>

Transforms a KResult to a Kotlin native kotlin.Result

combine

fun <E, T> KResult<E, T>.combine(other: KResult<E, T>, combineFailure: (E, E) -> E, combineSuccess: (T, T) -> T): KResult<E, T>

compareTo

operator fun <E : Comparable<E>, T : Comparable<T>> KResult<E, T>.compareTo(other: KResult<E, T>): Int

component1

open operator fun component1(): E?

Failure component for destructuring declaration

component2

open operator fun component2(): Nothing?

Success component for destructuring declaration

equals

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

errors

fun <E, T> MultiErrorKResult<E, T>.errors(): List<E>

Returns a list of errors

failureOrDefault

infix inline fun <E, T> KResult<E, T>.failureOrDefault(default: (T) -> E): E

Returns the error of the Failure side, or the result of the default function otherwise

failureOrNull

fun failureOrNull(): E?

Runs the Failure.error, if the KResult is a failure or null otherwise

filter

inline fun <E, T> KResult<E, T>.filter(failureValue: E, f: (success: T) -> Boolean): KResult<E, T>

inline fun <E, T> KResult<E, T>.filter(failureFn: (success: T) -> E, f: (success: T) -> Boolean): KResult<E, T>

flatMap

inline fun <E, T, T1> KResult<E, T>.flatMap(f: (success: T) -> KResult<E, T1>): KResult<E, T1>

flatMapFailure

fun <E, T, E1> KResult<E, T>.flatMapFailure(f: (failure: E) -> KResult<E1, T>): KResult<E1, T>

flatten

fun <E, T> KResult<E, KResult<E, T>>.flatten(): KResult<E, T>

flattenFailure

fun <E, T> KResult<KResult<E, T>, T>.flattenFailure(): KResult<E, T>

fold

inline fun <R> fold(ifFailure: (failure: E) -> R, ifSuccess: (success: Nothing) -> R): R

Transforms a KResult into a value of R.

getOrDefault

infix inline fun <E, T> KResult<E, T>.getOrDefault(default: (E) -> T): T

Returns the value of the Success side, or the result of the default function otherwise

getOrElse

infix inline fun <E, T> KResult<E, T>.~~getOrElse~~(default: (E) -> T): T

getOrNull

fun getOrNull(): Nothing?

Runs the Success.value, if the KResult is a success or null otherwise

getOrThrow

fun <E : Throwable, T> KResult<E, T>.getOrThrow(): T

If a KResult has a Throwable on failure side, this either returns the Success.value or throws the Failure.error

hashCode

open override fun hashCode(): Int

isFailure

fun isFailure(): Boolean

Indicates if a KResult is a Failure

isSuccess

fun isSuccess(): Boolean

Indicates if a KResult is a Success

map

inline fun <R> map(f: (success: Nothing) -> R): KResult<E, R>

Maps (transforms) the success value T to a new value R

mapFailure

inline fun <R> mapFailure(f: (E) -> R): KResult<R, Nothing>

Maps (transforms) the failure value E to a new value R

merge

fun <T> KResult<T, T>.merge(): T

onFailure

inline fun onFailure(action: (failure: E) -> Unit): KResult<E, Nothing>

Runs an action (side-effect) when the KResult is a Failure

onSuccess

inline fun onSuccess(action: (success: Nothing) -> Unit): KResult<E, Nothing>

Runs an action (side-effect) when the KResult is a Success

swap

fun swap(): KResult<Nothing, E>

Swap the parameters (T and E) of this Result.

toString

open override fun toString(): String

validate

inline fun <E, T> MultiErrorKResult<E, T>.validate(failureValue: E, expectationFn: (success: T) -> Boolean): MultiErrorKResult<E, T>

Validates a Success or a FailureWithValue against a predicate (expectationFn] and applies failureValue if not fulfilled

withValue

fun <T> withValue(value: T): KResult.FailureWithValue<E, T>

Extends an existing Failure with a value to produce a FailureWithValue