client/io.github.octaviusframework.client/DataResult

DataResult

sealed class DataResult<out T>

The outcome of a database operation: a value, or the failure that replaced it.

The result style - dbResult, transactionResult and asResult - returns one for the failures the database reports: a violated constraint, a deadlock, a routine's RAISE EXCEPTION, a timeout. A failure that means the calling code is wrong is thrown instead.

Type Parameters

The type of the value carried on success.

Inheritors

Success

Failure

Constructors

DataResult

protected constructor()

Types

Failure

data class Failure(val error: OctaviusException) : DataResult<Nothing>

The database reported error and the operation produced no value.

Success

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

The operation completed and produced value.

Functions

getOrElse

inline fun <R, T : R> DataResult<T>.getOrElse(onFailure: (DataResult.Failure) -> R): R

Returns the carried value, or what onFailure makes of the whole DataResult.Failure - which it can return as it is, for an early exit:

getOrNull

fun <T> DataResult<T>.getOrNull(): T?

Returns the carried value, or null where the operation failed.

getOrThrow

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

Returns the carried value, or throws the carried failure.

map

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

Applies transform to the value of a DataResult.Success, and returns a DataResult.Failure as it stands.

onFailure

inline fun <T> DataResult<T>.onFailure(action: (OctaviusException) -> Unit): DataResult<T>

Runs action on the failure if this is a DataResult.Failure, and returns this result either way.

onSuccess

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

Runs action on the carried value if this is a DataResult.Success, and returns this result either way.