core/pro.respawn.flowmvi.api/ImmediateStateReceiver

ImmediateStateReceiver

interface ImmediateStateReceiver<S : MVIState> : StateProvider<S>

StateReceiver version that can only accept immediate state updates. It is recommended to use StateReceiver and its methods if possible. See the method docs for details

Inheritors

Properties

Link copied to clipboard
val <S : MVIState> StateProvider<S>.state: S

Obtain the current state in an unsafe manner.

Link copied to clipboard
abstract override val states: StateFlow<S>

A flow of states to be rendered by the subscriber.

Functions

Link copied to clipboard
abstract fun compareAndSet(old: S, new: S): Boolean

Directly compare and set the current state.

Link copied to clipboard
@JvmName(name = "updateStateImmediateTyped")
inline fun <T : S, S : MVIState> ImmediateStateReceiver<S>.updateStateImmediate(transform: T.() -> S)

A typed overload of updateStateImmediate.

inline fun <S : MVIState> ImmediateStateReceiver<S>.updateStateImmediate(transform: 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.