orbit-core/org.orbitmvi.orbit.syntax

Package-level declarations

Types

data class ContainerContext<S : Any, SE : Any>(val settings: RealSettings, val postSideEffect: suspend (SE) -> Unit, val reduce: suspend ((S) -> S) -> Unit, val subscribedCounter: SubscribedCounter, val stateFlow: StateFlow<S>)

IntentContext

data class IntentContext<STATE : Any>(val state: STATE)

Represents the current context in which a simple orbit is executing.

Operator

interface Operator<S : Any, E>

SubStateContainerContext

data class SubStateContainerContext<S : Any, SE : Any, T : S>(val settings: RealSettings, val postSideEffect: suspend (SE) -> Unit, getState: () -> T, val reduce: suspend ((T) -> S) -> Unit, val subscribedCounter: SubscribedCounter)

SubStateSyntax

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

Syntax

class Syntax<S : Any, SE : Any>(val containerContext: ContainerContext<S, SE>)

Functions

runOn

inline suspend fun <S : Any, T : S> Flow<S>.runOn(crossinline predicate: (T) -> Boolean = { true }, crossinline block: suspend (capturedState: T) -> Unit)

This API is intended to simplify and add type-safety to working with sealed class states. This can be applied to any Flow of states, not just the Container's own. The main purpose of this API is to help you work with child container states.

toSubclassContainerContext

inline fun <S : Any, SE : Any, T : S> ContainerContext<S, SE>.toSubclassContainerContext(crossinline predicate: (T) -> Boolean = { true }, capturedState: T): SubStateContainerContext<S, SE, T>