api/org.octavius.data/DataResult

DataResult

sealed class DataResult<out T>

Container for a database operation result, which can end in success or failure. Replaces the exception mechanism, forcing explicit handling of both cases.

Parameters

Data type in case of success.

Inheritors

Success

Failure

Constructors

DataResult

protected constructor()

Types

Failure

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

Represents an error during operation.

Success

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

Represents successful operation execution.

Functions

getOrElse

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

Returns the value if the result is Success, or computes a default value from the error if it is Failure.

getOrThrow

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

Returns the value if the result is Success, or throws an exception if it is Failure.

map

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

Transforms the value inside DataResult.Success, leaving DataResult.Failure unchanged.

onFailure

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

Executes an action if the result is Failure, without modifying the original error.

onSuccess

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

Executes an action if the result is Success, without modifying the original value.