core/pro.respawn.flowmvi.api/StateReceiver

StateReceiver

An entity that handles MVIState updates. This entity modifies the state of the StateProvider. This is most often implemented by a Store and exposed through PipelineContext.

Inheritors

PipelineContext

Properties

state

abstract val state: S

Obtain the current value of state in an unsafe manner. It is recommended to always use withState or updateState as obtaining this value can lead to data races when the state transaction changes the value of the state previously obtained.

Functions

updateState

abstract suspend fun updateState(transform: suspend S.() -> S)

Obtain the current StateProvider.state and update it with the result of transform.

updateState

inline suspend fun <T : S, S : MVIState> StateReceiver<S>.updateState(crossinline transform: suspend T.() -> S)

A typed overload of StateReceiver.updateState.

updateStateImmediate

abstract fun updateStateImmediate(block: S.() -> S)

A function that obtains current state and updates it atomically (in the thread context), and non-atomically in the coroutine context, which means it can cause races when you want to update states in parallel.

updateStateImmediate

inline fun <T : S, S : MVIState> StateReceiver<S>.updateStateImmediate(crossinline transform: T.() -> S)

A typed overload of StateReceiver.updateStateImmediate.

useState

open fun ~~useState~~(block: S.() -> S)

useState

inline fun <T : S, S : MVIState> StateReceiver<S>.~~useState~~(crossinline transform: T.() -> S)

withState

abstract suspend fun withState(block: suspend S.() -> Unit)

Obtain the current state and operate on it without changing the state.

withState

inline suspend fun <T : S, S : MVIState> StateReceiver<S>.withState(crossinline block: suspend T.() -> Unit)

A typed overload of StateReceiver.withState.