sdk/com.processout.sdk.core/ProcessOutResult

ProcessOutResult

sealed class ProcessOutResult<out T : Any>

Provides Success or Failure as a result of operation.

Inheritors

Types

data class Failure(val code: POFailure.Code, val message: String? = null, val invalidFields: List<POFailure.InvalidField>? = null, val cause: Exception? = null) : ProcessOutResult<Nothing>

Provides detailed information about an error that occurred.

Success

data class Success<out T : Any>(val value: T) : ProcessOutResult<T>

Provides successful result with a value.

Functions

copy

fun <T : Any> ProcessOutResult<T>.copy(): ProcessOutResult<T>

Returns the unmodified copy of the result.

fold

inline fun <T : Any, R> ProcessOutResult<T>.fold(onSuccess: (value: T) -> R, onFailure: (failure: ProcessOutResult.Failure) -> R): R

Returns the result of onSuccess for the encapsulated value if this instance represents Success or the result of onFailure for the encapsulated failure if it is Failure.

getOrNull

fun <T : Any> ProcessOutResult<T>.getOrNull(): T?

Returns the encapsulated value if this instance represents Success or null if it is Failure.

handleFailure

inline fun <T : Any> ProcessOutResult<T>.~~handleFailure~~(block: (code: POFailure.Code, message: String?, invalidFields: List<POFailure.InvalidField>?, Exception?) -> Unit)

handleSuccess

inline fun <T : Any> ProcessOutResult<T>.~~handleSuccess~~(block: (value: T) -> Unit)

map

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

Returns the encapsulated result of the given transform function applied to the encapsulated value if this instance represents Success or the unmodified copy if it is Failure.

onFailure

inline fun <T : Any> ProcessOutResult<T>.onFailure(action: (failure: ProcessOutResult.Failure) -> Unit): ProcessOutResult<T>

Performs the given action on the encapsulated failure if this instance represents Failure. Returns the original ProcessOutResult unchanged.

onSuccess

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

Performs the given action on the encapsulated value if this instance represents Success. Returns the original ProcessOutResult unchanged.

toActivityResult

fun <T : Parcelable> ProcessOutResult<T>.toActivityResult(): ProcessOutActivityResult<T>

Maps ProcessOutResult to parcelable ProcessOutActivityResult.