pubnub-kotlin-core-api/com.pubnub.api.v2.callbacks/Result

Result

class Result<out T>

A discriminated union that encapsulates a successful outcome with a value of type T or a failure with a PubNubException.

Types

Companion

object Companion

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

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

exceptionOrNull

fun exceptionOrNull(): PubNubException?

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

fold

inline fun <R, T> Result<T>.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.

getOrDefault

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

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

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

getOrNull

inline fun getOrNull(): T?

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

getOrThrow

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

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

map

inline 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.

mapCatching

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

onFailure

inline fun onFailure(action: Consumer<PubNubException>): Result<T>

onSuccess

inline fun onSuccess(action: Consumer<in T>): Result<T>

toString

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.

wrapException

inline fun <T> Result<T>.wrapException(block: (PubNubException) -> PubNubException): Result<T>