State/opensavvy.state.progressive

Package-level declarations

The ProgressiveOutcome, which combines Outcome with Progress.

Types

ProgressiveOutcome

sealed class ProgressiveOutcome<out Failure, out Value>

A Outcome with integrated Progress management.

Properties

failure

val <Failure> ProgressiveOutcome<Failure, Nothing>.failure: Failure

Returns Failure.failure.

failureOrNull

val <Failure> ProgressiveOutcome<Failure, *>.failureOrNull: Failure?

Returns Failure.failure, or null if this outcome is not a failure.

progress

val <Failure> ProgressiveOutcome.Unsuccessful<Failure>.progress: Progress

The progression of this unsuccessful value.

value

val <Value> ProgressiveOutcome<Nothing, Value>.value: Value

Returns Success.value.

valueOrNull

val <Value : Any> ProgressiveOutcome<*, Value>.valueOrNull: Value?

Returns Success.value, or null if this outcome is not successful.

Functions

asOutcome

fun <Failure, Value> ProgressiveOutcome<Failure, Value>.asOutcome(): Outcome<Failure, Value>?

Converts this progressive outcome into a regular outcome.

combineCompleted

fun <Failure, Value> Iterable<ProgressiveOutcome<Failure, Value>>.combineCompleted(): Iterable<ProgressiveOutcome<Failure, Value>>

fun <Failure, Value> Sequence<ProgressiveOutcome<Failure, Value>>.combineCompleted(): Sequence<ProgressiveOutcome<Failure, Value>>

Replaces incomplete outcomes by the previous completed outcome, with the updated progress information.

component1

operator fun <Failure, Value> ProgressiveOutcome<Failure, Value>.component1(): Outcome<Failure, Value>?

Syntax sugar for asOutcome.

component2

operator fun ProgressiveOutcome<*, *>.component2(): Progress

Syntax sugar for ProgressiveOutcome.progress.

copy

fun <Failure, Value> ProgressiveOutcome<Failure, Value>.copy(progress: Progress.Loading): ProgressiveOutcome<Failure, Value>

Replaces the progress information from this progressive outcome.

explode

@ExperimentalProgressApi

fun <Failure, Value> ProgressiveOutcome<Failure, Value>.explode(): Progressive<Outcome<Failure, Value>?>

Converts a ProgressiveOutcome into a Progressive.

failedWithProgress

fun <Failure> Failure.failedWithProgress(progress: Progress = done()): ProgressiveOutcome.Failure<Failure>

Convenience function to instantiate a ProgressiveOutcome.Failure.

flatten

@ExperimentalProgressApi

fun <Failure, Value> Progressive<Outcome<Failure, Value>>.flatten(): ProgressiveOutcome<Failure, Value>

Converts an Outcome nested in a Progressive into a ProgressiveOutcome.

map

inline fun <Failure, InputValue, OutputValue> ProgressiveOutcome<Failure, InputValue>.map(transform: (InputValue) -> OutputValue): ProgressiveOutcome<Failure, OutputValue>

If this outcome is successful, replaces its value using transform.

mapFailure

inline fun <InputFailure, Value, OutputFailure> ProgressiveOutcome<InputFailure, Value>.mapFailure(transformFailure: (InputFailure) -> OutputFailure): ProgressiveOutcome<OutputFailure, Value>

If this outcome is failed, replaces its failure using transformFailure.

onFailure

inline fun <Failure> ProgressiveOutcome<Failure, *>.onFailure(block: (Failure) -> Unit)

Executes block if this outcome is a failure.

onIncomplete

inline fun ProgressiveOutcome<*, *>.onIncomplete(block: () -> Unit)

Executes block if this outcome is incomplete.

onLoading

inline fun ProgressiveOutcome<*, *>.onLoading(block: (Progress.Loading) -> Unit)

Executes block if this outcome is loading (its ProgressiveOutcome.progress is Progress.Loading).

onSuccess

inline fun <Value> ProgressiveOutcome<*, Value>.onSuccess(block: (Value) -> Unit)

Executes block if this outcome is successful.

successfulWithProgress

fun <Value> Value.successfulWithProgress(progress: Progress = done()): ProgressiveOutcome.Success<Value>

Convenience function to instantiate a ProgressiveOutcome.Success.

upcast

fun <Failure> ProgressiveOutcome.Unsuccessful<Failure>.upcast(): ProgressiveOutcome<Failure, Nothing>

Type-safe way to convert between an Unsuccessful and a ProgressiveOutcome.

withProgress

fun <Failure, Value> Outcome<Failure, Value>.withProgress(progress: Progress = done()): ProgressiveOutcome<Failure, Value>

Adds progress information to this outcome to make it a ProgressiveOutcome.