api-client/com.gw2tb.gw2api.client/DecodingResult

DecodingResult

A discriminated union that encapsulates a successful outcome with a value of type T or a failure with an arbitrary Throwable exception. A schema mismatch is a special type of failure that may be partially recoverable.

Since

0.4.0

Types

Companion

object Companion

Properties

isFailure

val isFailure: Boolean

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

isSchemaMismatch

val isSchemaMismatch: Boolean

Returns true if this instance represents a schema mismatch. 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(): Throwable?

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

fold

fun <R, T> DecodingResult<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 for the encapsulated Throwable if this instance represents failure.

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

Returns the result of onSuccess for the encapsulated value if this instance represents success, the result of onSchemaMismatch for the encapsulated JsonElement and Throwable if this instance represents a schema mismatch, or the result of onFailure for the encapsulated Throwable if this instance represents any other failure.

getOrDefault

inline fun <R, T : R> DecodingResult<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> DecodingResult<T>.getOrElse(onFailure: (exception: Throwable) -> R): R

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

inline fun <R, T : R> DecodingResult<T>.getOrElse(onSchemaMismatch: (JsonElement, exception: Throwable) -> R, onFailure: (exception: Throwable) -> R): R

Returns the encapsulated value if this instance represents success, the result of onSchemaMismatch for the encapsulated JsonElement and Throwable if it is schema mismatch or the result of onFailure for the encapsulated Throwable 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

inline fun <T> DecodingResult<T>.getOrThrow(): T

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

map

inline fun <R, T> DecodingResult<T>.map(transform: (value: T) -> R): DecodingResult<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 if it is failure.

mapCatching

inline fun <R, T> DecodingResult<T>.mapCatching(transform: (value: T) -> R): DecodingResult<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 if it is failure.

onFailure

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

Performs the given action on the encapsulated Throwable exception if this instance represents failure. Returns the receiver DecodingResult.

onSuccess

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

Performs the given action on the encapsulated value if this instance represents success. Returns the receiver DecodingResult.

recover

inline fun <R, T : R> DecodingResult<T>.recover(transform: (exception: Throwable) -> R): DecodingResult<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.

recoverCatching

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

toString

open override fun toString(): String

Returns a string representation of this result.

tryRecoverPartially

fun <E> DecodingResult<List<E>>.tryRecoverPartially(json: Json = Json, deserializer: DeserializationStrategy<E>): List<DecodingResult<E>>

fun <K, V> DecodingResult<Map<K, V>>.tryRecoverPartially(json: Json = Json, keyDeserializer: DeserializationStrategy<K>, deserializer: DeserializationStrategy<V>): Map<K, DecodingResult<V>>

Tries to recover the response partially if the result represents a schema mismatch. If the result represents another failure, an IllegalStateException is thrown. Successful results are simply transformed.