outcome/nz.adjmunro.outcome.fetch/Prefetch

Prefetch

data object Prefetch : Fetch<Nothing>

A fetch operation that has not yet been started.

This is for default states, and is not generally emitted.

Properties

flatten

val <T : Any> Fetch<Fetch<T>>.flatten: Fetch<T>

Flatten a nested Fetch into a single Fetch.

isEmpty

val <T : Any> Fetch<T>.isEmpty: Boolean

isNotEmpty

val <T : Any> Fetch<T>.isNotEmpty: Boolean

isNotFetching

val <T : Any> Fetch<T>.isNotFetching: Boolean

isNotFinished

val <T : Any> Fetch<T>.isNotFinished: Boolean

isStarted

val <T : Any> Fetch<T>.isStarted: Boolean

Functions

flatMapFetching

inline fun <In : Out, Out : Any> Fetch<In>.flatMapFetching(transform: Fetching<In>.() -> Fetch<Out>): Fetch<Out>

Flatmap a Fetching state.

flatMapFinished

inline fun <In : Out, Out : Any> Fetch<In>.flatMapFinished(transform: Finished<In>.() -> Fetch<Out>): Fetch<Out>

Flatmap a Finished state.

flatMapPrefetch

inline fun <In : Out, Out : Any> Fetch<In>.flatMapPrefetch(transform: Prefetch.() -> Fetch<Out>): Fetch<Out>

Flatmap a Prefetch state.

fold

inline fun <Data : Any, Output> Fetch<Data>.fold(prefetch: Prefetch.() -> Output, fetching: Fetching<Data>.() -> Output, finished: Finished<Data>.() -> Output): Output

Transform all Fetch status into the Output type.

getOrDefault

infix fun <T : Any> Fetch<T>.getOrDefault(default: T): T

Unwrap the internal value of a Fetch, or default.

getOrElse

inline fun <T> Fetch<T & Any>.getOrElse(recover: (Fetch<T & Any>) -> T): T

Unwrap the internal value of a Fetch, or recover.

getOrNull

fun <T : Any> Fetch<T>.getOrNull(): T?

Unwrap the internal value of a Fetch, or null.

getOrThrow

fun <T : Any> Fetch<T>.getOrThrow(): T

Unwrap the internal value of a Fetch, or throw.

isFetching

fun <T : Any> Fetch<T>.isFetching(): Boolean

inline fun <T : Any> Fetch<T>.isFetching(predicate: Fetching<T>.() -> Boolean): Boolean

isFinished

fun <T : Any> Fetch<T>.isFinished(): Boolean

inline fun <T : Any> Fetch<T>.isFinished(predicate: Finished<T>.() -> Boolean): Boolean

isPrefetch

fun <T : Any> Fetch<T>.isPrefetch(): Boolean

mapFetching

inline fun <In : Out, Out : Any> Fetch<In>.mapFetching(transform: Fetching<In>.() -> Out?): Fetch<Out>

Transforms Fetching.cache in place.

mapFinished

inline fun <In : Out, Out : Any> Fetch<In>.mapFinished(transform: Finished<In>.() -> Out): Fetch<Out>

Transforms Finished.result in place.

mapToCache

inline fun <In : Out, Out : Any> Fetch<In>.mapToCache(transform: Finished<In>.() -> Out? = Finished<In>::result): Fetch<Out>

Transforms Finished.result into Fetching.cache.

onFetching

inline fun <T : Any> Fetch<T>.onFetching(action: Fetching<T>.() -> Unit): Fetch<T>

also do an action, if Fetch is Fetching.

onFinished

inline fun <T : Any> Fetch<T>.onFinished(action: Finished<T>.() -> Unit): Fetch<T>

also do an action, if Fetch is Finished.

onPrefetch

inline fun <T : Any> Fetch<T>.onPrefetch(action: Prefetch.() -> Unit): Fetch<T>

also do an action, if Fetch is Prefetch.

toFaulty

fun Fetch<*>.toFaulty(): Faulty<Throwable>

Convert a Fetch to a Faulty by catching and wrapping any exceptions thrown by getOrThrow.

toKotlinResult

fun <T : Any> Fetch<T>.toKotlinResult(): KotlinResult<T>

Convert a Fetch to a KotlinResult by catching the resultOf any exceptions thrown by getOrThrow.

toMaybe

fun <Ok : Any> Fetch<Ok>.toMaybe(): Maybe<Ok>

Convert a Fetch to a Maybe by catching and suppressing any exceptions thrown by getOrThrow.

toOutcome

fun <Ok : Any> Fetch<Ok>.toOutcome(): Outcome<Ok, Throwable>

Convert a Fetch to an Outcome by catching any exceptions thrown by getOrThrow.