client/io.github.octaviusframework.client

Package-level declarations

Types

DataResult

sealed class DataResult<out T>

The outcome of a database operation, which either carries a value or the failure that replaced it.

OctaviusClient

interface OctaviusClient : AutoCloseable

Hands out queries and sessions, and runs transactions over them. That is all it is.

OctaviusClientImpl

internal class OctaviusClientImpl(provider: SessionProvider, onClose: () -> Unit? = null, dynamicJson: Json = octaviusJson, dynamicWriteStrategy: DynamicWriteStrategy = DynamicWriteStrategy.AUTOMATIC_WHEN_UNAMBIGUOUS) : OctaviusClient

The only implementation of OctaviusClient. Everything it does, it does through its SessionProvider.

RollbackSignal

internal class RollbackSignal(val failure: DataResult.Failure) : RuntimeException

Carries a DataResult.Failure out through a transaction that only understands exceptions.

Functions

dbResult

inline fun <T> dbResult(crossinline block: () -> T): DataResult<T>

Runs block and hands back what it produced as a DataResult, turning the failures an application is expected to handle into DataResult.Failure and letting the ones that mean broken code go on being thrown.

getOrElse

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

Returns the carried value, or what onFailure makes of the failure.

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, throwing the failure in its place.

isCallerBug

@PublishedApi

internal fun isCallerBug(e: OctaviusException): Boolean

Whether this failure says the calling code is wrong, rather than that the operation did not work out.

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.