core/pro.respawn.flowmvi.api/Store

Store

interface Store<out S : MVIState, in I : MVIIntent, out A : MVIAction> : ImmutableStore<S, I, A> , IntentReceiver , StoreLifecycle

A central business logic unit for handling MVIIntents, MVIActions, and MVIStates. Usually not subclassed but used with a corresponding builder (see pro.respawn.flowmvi.dsl.store).

A Store functions independently of any subscribers,
Store has its own StoreLifecycle, can be stopped and relaunched at will via StoreLifecycle returned from start or as this StoreLifecycle reference.
The store can be mutated only through MVIIntent.
Store is an IntentReceiver

Inheritors

NativeStore

Properties

isActive

abstract val isActive: Boolean

Whether the Store is active (store is started or being started).

isStarted

abstract val isStarted: Boolean

Whether the Store has started fully.

name

abstract val name: String?

The name of the store. Used for debugging purposes and when storing multiple stores in a collection. Optional and configured through a pro.respawn.flowmvi.dsl.StoreBuilder

state

val <S : MVIState> StateProvider<S>.state: S

Obtain the current state in an unsafe manner.

states

abstract override val states: StateFlow<S>

A flow of states to be rendered by the subscriber.

Functions

awaitStartup

abstract suspend fun awaitStartup()

Wait while the Store is started. If it is already started, returns immediately.

awaitUntilClosed

abstract suspend fun awaitUntilClosed()

Suspend until the store is closed

expect abstract fun close()

closeAndWait

abstract suspend fun closeAndWait()

Await while the Store is fully closed.

collect

inline suspend fun <S : MVIState, I : MVIIntent, A : MVIAction> ImmutableStore<S, I, A>.collect(crossinline consume: suspend Provider<S, I, A>.() -> Unit)

Subscribe to this store and suspend until consume finishes (which should never return). This means the function will suspend forever.

emit

abstract suspend fun emit(intent: I)

Alias for intent with one difference - this function will suspend if pro.respawn.flowmvi.dsl.StoreBuilder.onOverflow permits it.

emit

inline suspend fun IntentReceiver.emit(vararg intents: I)

Alias for IntentReceiver.emit for multiple intents

equals

abstract operator override fun equals(other: Any?): Boolean

hashCode

abstract override fun hashCode(): Int

intent

abstract fun intent(intent: I)

Send an intent asynchronously. The intent is sent to the receiver and is placed in a queue. When IntentReceiver is available (e.g. when the Store is started), the intent will be processed. Intents that overflow the buffer will be handled according to the behavior specified in pro.respawn.flowmvi.dsl.StoreBuilder.onOverflow. If the store is not started when an intent is sent, it will wait in the buffer, and will be processed once the store is started.

intent

inline fun IntentReceiver.intent(vararg intents: I)

Alias for IntentReceiver.intent for multiple intents

fun <S : MVIState, A : MVIAction> IntentReceiver<LambdaIntent<S, A>>.intent(block: suspend PipelineContext<S, LambdaIntent<S, A>, A>.() -> Unit)

An alias for pro.respawn.flowmvi.api.IntentReceiver.intent (LambdaIntent (block))

send

fun IntentReceiver.send(intent: I)

Alias for IntentReceiver.intent

inline fun IntentReceiver.send(vararg intents: I)

Alias for IntentReceiver.intent for multiple intents

fun <S : MVIState, A : MVIAction> IntentReceiver<LambdaIntent<S, A>>.send(block: suspend PipelineContext<S, LambdaIntent<S, A>, A>.() -> Unit)

An alias for pro.respawn.flowmvi.api.IntentReceiver.send (LambdaIntent (block))

start

abstract override fun start(scope: CoroutineScope): StoreLifecycle

Starts store intent processing in a new coroutine in the given scope. Intents are processed as long as the parent scope is active.

abstract fun CoroutineScope.subscribe(block: suspend Provider<S, I, A>.() -> Unit): Job

Subscribe to the store, obtaining a Provider to consume MVIStates and MVIActions. The store itself does not expose actions or states to prevent subscribers from affecting the store and to keep track of each subscription. When subscribe is invoked, a new StorePlugin.onSubscribe event is sent to all plugins with the new subscriber count. For more, see StorePlugin.