orbit-core/org.orbitmvi.orbit.syntax/SubStateSyntax

SubStateSyntax

class SubStateSyntax<S : Any, SE : Any, T : S>(containerContext: SubStateContainerContext<S, SE, T>)(source)

Constructors

constructor(containerContext: SubStateContainerContext<S, SE, T>)

Properties

val state: T

The current state which can change throughout execution of the orbit block

Functions

suspend fun postSideEffect(sideEffect: SE)

Side effects allow you to deal with things like tracking, navigation etc.

suspend fun reduce(reducer: IntentContext<T>.() -> S)

Reducers reduce the current state and incoming events to produce a new state.

repeatOnSubscription

suspend fun repeatOnSubscription(block: suspend CoroutineScope.() -> Unit)

Starts and stops the provided block of code based on the number of subscribers to the Container.refCountStateFlow and Container.refCountSideEffectFlow.