result/com.siddharth.kmp.result

Package-level declarations

Types

sealed interface DataError

Root of the typed error hierarchy carried in Result.Failure. Split by source so callers can react differently to a network failure vs a local one. Apps extend this with their own arms (e.g. a Validation error) by implementing the interface.

typealias EmptyResult<E> = Result<Unit, E>

A Result carrying no success payload — for operations whose success is just "it worked".

sealed interface Result<out D, out E>

A typed success-or-failure. Unlike kotlin.Result, the error arm is a typed E (usually a DataError) rather than a Throwable, so callers exhaustively handle known failure modes instead of catching. Import this Result explicitly where kotlin.Result is also in scope.

Functions

fun <D, E> Result<D, E>.asEmpty(): EmptyResult<E>

Discard the success payload, keeping only success-vs-failure.

fun <D, E> Result<D, E>.errorOrNull(): E?

inline fun <D, E, R> Result<D, E>.flatMap(transform: (D) -> Result<R, E>): Result<R, E>

Chain a success into another Result; failures short-circuit.

inline fun <D, E, R> Result<D, E>.fold(onSuccess: (D) -> R, onFailure: (E) -> R): R

Collapse both arms into one value.

fun <D, E> Result<D, E>.getOrNull(): D?

inline fun <D, E, R> Result<D, E>.map(transform: (D) -> R): Result<R, E>

Map the success value; failures pass through untouched.

inline fun <D, E, F> Result<D, E>.mapError(transform: (E) -> F): Result<D, F>

Map the error arm; successes pass through untouched.

inline fun <D, E> Result<D, E>.onFailure(action: (E) -> Unit): Result<D, E>

Run action on failure, returning the receiver for chaining.

inline fun <D, E> Result<D, E>.onSuccess(action: (D) -> Unit): Result<D, E>

Run action on success, returning the receiver for chaining.