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

val isFailure: Boolean

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

val isSuccess: Boolean

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

fun exceptionOrNull(): Throwable?

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

fun getOrNull(): T?

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.

fun toString(): String

Returns an instance that encapsulates the given Throwable as failure.

fun <T> failure(exception: Throwable): Result<T>

Returns an instance that encapsulates the given value as successful value.

fun <T> success(value: T): Result<T>

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.

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

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

fun <R, T : R> Result<T>.getOrDefault(defaultValue: 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.

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

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

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

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.

fun <R, T> Result<T>.map(
    transform: (value: 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.

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

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

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

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

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

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.

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.

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