KmmResult

@ObjCName(swiftName = "KmmResult", name = "KmmResult")

Swift-Friendly variant of stdlib's Result. For easy use under iOS, we need a class like Result that is not a value class (which is unsupported in Kotlin/Native)

Trying to create a failure case re-throws any fatal exceptions, such as OutOfMemoryError. Relies on Arrow's nonFatalOrThrow internally.

Constructors

KmmResult

constructor(value: T)

Creates a success result from the given value

constructor(failure: Throwable)

Creates a failure result from the given failure Trying to create a failure case re-throws any fatal exceptions, such as OutOfMemoryError. Relies on Arrow's nonFatalOrThrow internally.

Types

Companion

object Companion

Properties

isFailure

val isFailure: Boolean

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

isSuccess

val isSuccess: Boolean

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

Functions

equals

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

exceptionOrNull

fun exceptionOrNull(): Throwable?

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

fold

inline fun <R> fold(onSuccess: (value: 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.

getOrElse

inline fun getOrElse(onFailure: (exception: Throwable) -> @UnsafeVariance T): T

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

getOrNull

fun getOrNull(): T?

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

getOrThrow

fun getOrThrow(): T

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

hashCode

open override fun hashCode(): Int

map

inline fun <R> map(block: (T) -> R): KmmResult<R>

Transforms this KmmResult's success-case according to block and leaves the failure case untouched

mapCatching

inline fun <R> mapCatching(block: (T) -> R): KmmResult<R>

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

mapFailure

inline fun mapFailure(block: (Throwable) -> Throwable): KmmResult<T>

Transforms this KmmResult's failure-case according to block and leaves the success case untouched

onFailure

inline fun <R> onFailure(block: (error: Throwable) -> R): KmmResult<T>

singular version of fold's onFailure

onSuccess

inline fun <R> onSuccess(block: (value: T) -> R): KmmResult<T>

singular version of fold's onSuccess

recoverCatching

inline fun <R, T : R> KmmResult<T>.recoverCatching(block: (error: Throwable) -> R): KmmResult<R>

If this is successful, returns it. If this is failed, encapsulate the result of the provided recovery function. If the recovery function throws, the return value is a failed KmmResult.

toString

open override fun toString(): String

transform

inline fun <R> transform(block: (T) -> KmmResult<R>): KmmResult<R>

Transforms this KmmResult into a KmmResult of different success type according to block and leaves the failure case untouched. Avoids nested KmmResults.

unwrap

fun unwrap(): Result<T>

Returns a Result equivalent of this KmmResult