imahub-sdk-hub-core/imahub.sdk.hub/ErrorPayload

ErrorPayload

data class ErrorPayload : HubPayload<Nothing>

Encapsulates an error outcome with a message and an errorCode.

Functions

errorOrNull

fun errorOrNull(): ErrorPayload?

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

fold

inline fun <T, R> HubPayload<T>.fold(onSuccess: (value: T) -> R, onFailure: (error: ErrorPayload) -> 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 ErrorPayload if it is failure.

getOrElse

inline fun <T : R, R> HubPayload<T>.getOrElse(onFailure: (error: ErrorPayload) -> R): R

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

getOrNull

fun getOrNull(): Nothing?

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

getOrThrow

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

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

map

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

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

onFailure

inline fun <T> HubPayload<T>.onFailure(action: (error: ErrorPayload) -> Unit): HubPayload<T>

Performs the given action on the encapsulated ErrorPayload if this instance represents failure. Returns the original HubPayload unchanged.

onSuccess

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

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

toString

open override fun toString(): String

toThrowable

fun toThrowable(): Throwable

Converts the ErrorPayload to Throwable.

Properties

errorCode

val errorCode: Int

message

val message: String