Result

Companion

Common

object Companion

Companion object for Result class that contains its constructor functions success and failure.

exceptionOrNull

Common

fun exceptionOrNull(): Throwable?

Returns the encapsulated Throwable exception if this instance represents failure or null if it is success.

getOrNull

Common

inline fun getOrNull(): T?

Returns the encapsulated value if this instance represents success or null if it is failure.

toString

Common

open override fun toString(): String

Returns a string Success(v) if this instance represents success where v is a string representation of the value or a string Failure(x) if it is failure where x is a string representation of the exception.

isFailure

Common

val isFailure: Boolean

Returns true if this instance represents a failed outcome. In this case isSuccess returns false.

isSuccess

Common

val isSuccess: Boolean

Returns true if this instance represents a successful outcome. In this case isFailure returns false.

fold

Common

inline fun <R, T> Result<T>.fold(onSuccess: (T) -> R, onFailure: (exception: Throwable) -> R): R

Returns the result of onSuccess for the encapsulated value if this instance represents success or the result of onFailure function for the encapsulated Throwable exception if it is failure.

getOrDefault

Common

inline fun <R, T : R> Result<T>.getOrDefault(defaultValue: R): R

Returns the encapsulated value if this instance represents success or the defaultValue if it is failure.

getOrElse

Common

inline fun <R, T : R> Result<T>.getOrElse(onFailure: (exception: Throwable) -> R): R

Returns the encapsulated value if this instance represents success or the result of onFailure function for the encapsulated Throwable exception if it is failure.

getOrThrow

Common

inline fun <T> Result<T>.getOrThrow(): T

Returns the encapsulated value if this instance represents success or throws the encapsulated Throwable exception if it is failure.

map

Common

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

Returns the encapsulated result of the given transform function applied to the encapsulated value if this instance represents success or the original encapsulated Throwable exception if it is failure.

mapCatching

Common

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

Returns the encapsulated result of the given transform function applied to the encapsulated value if this instance represents success or the original encapsulated Throwable exception if it is failure.

onFailure

Common

inline fun <T> Result<T>.onFailure(action: (exception: Throwable) -> Unit): Result<T>

Performs the given action on the encapsulated Throwable exception if this instance represents failure. Returns the original Result unchanged.

onSuccess

Common

inline fun <T> Result<T>.onSuccess(action: (T) -> Unit): Result<T>

Performs the given action on the encapsulated value if this instance represents success. Returns the original Result unchanged.

recover

Common

inline fun <R, T : R> Result<T>.recover(transform: (exception: Throwable) -> R): Result<R>

Returns the encapsulated result of the given transform function applied to the encapsulated Throwable exception if this instance represents failure or the original encapsulated value if it is success.

recoverCatching

Common

inline fun <R, T : R> Result<T>.recoverCatching(transform: (exception: Throwable) -> R): Result<R>

Returns the encapsulated result of the given transform function applied to the encapsulated Throwable exception if this instance represents failure or the original encapsulated value if it is success.

Result

Since Kotlin

Types

Functions

Properties

Extensions