knomadic/nz.adjmunro.knomadic.fetch/Fetch

Fetch

sealed interface Fetch<out T : Any>

A wrapper for asynchronous fetch operations.

Fetch.Initial is for default states, and is not generally emitted;
Fetch.Fetching is emitted automatically before the fetch operation is executed when using fetch;
Fetch.Finished automatically encapsulates the result of the fetch operation.

Inheritors

Initial

Fetching

Finished

Types

Fetching

data object Fetching : Fetch<Nothing>

A fetch operation that is currently in progress.

Finished

@JvmInline

value class Finished<out T : Any>(val result: T) : Fetch<T>

A fetch operation that has finished.

Initial

data object Initial : Fetch<Nothing>

A fetch operation that has not yet been started.

Properties

flatten

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

Flatten a nested Fetch into a single Fetch.

isFetching

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

isNotFetching

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

isNotFinished

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

isNotStarted

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

isStarted

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

Functions

flatMapFetching

inline fun <T : Any> Fetch<T>.flatMapFetching(transform: () -> Fetch<T>): Fetch<T>

Transform a fetching fetch state to finished.

flatMapFinished

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

Transform a finished fetch result.

flatMapInitial

inline fun <T : Any> Fetch<T>.flatMapInitial(transform: () -> Fetch<T>): Fetch<T>

Transform an initial fetch state to finished.

fold

inline fun <T : Any, Output> Fetch<T>.fold(initial: () -> Output, fetching: () -> Output, finished: (result: T) -> Output): Output

Transform each Fetch status into an Output.

getOrDefault

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

getOrElse

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

getOrNull

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

getOrThrow

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

isFinished

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

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

mapFetchingToFinished

inline fun <T : Any> Fetch<T>.mapFetchingToFinished(transform: () -> T): Fetch<T>

Transform a fetching fetch state to finished.

mapFinished

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

Transform a finished fetch result.

mapInitialToFinished

inline fun <T : Any> Fetch<T>.mapInitialToFinished(transform: () -> T): Fetch<T>

Transform an initial fetch state to finished.

mapToFinished

inline fun <In : Any, Out : Any> Fetch<In>.mapToFinished(initial: () -> Out, fetching: () -> Out, finished: (result: In) -> Out): Fetch.Finished<Out>

Transform all Fetch states into a finished state.

onFetching

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

also do an action, if Fetch is in-progress.

onFinished

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

also do an action, if Fetch is finished.

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

inline fun <T : Any> Fetch<T>.onFinished(predicate: (result: T) -> Boolean, action: (T) -> Unit): Fetch<T>

also do an action, if predicate is true and Fetch is finished.

onInitial

inline fun <T : Any> Fetch<T>.onInitial(action: Fetch.Initial.() -> Unit): Fetch<T>

also do an action, if Fetch is initial.

unwrap

inline fun <T> Fetch<T & Any>.unwrap(recover: (Fetch<T & Any>) -> T = { error("Fetch has not finished!") }): T

Attempt to unwrap a Fetch to obtain it's result value.

Fetch

See also

Inheritors

Types

Properties

Functions