orbit-core/org.orbitmvi.orbit.syntax.simple/runOn

runOn

suspend fun <S : Any, SE : Any, T : S> SimpleSyntax<S, SE>.runOn(clazz: KClass<T>, predicate: (T) -> Boolean = { true }, block: suspend SubclassStateSimpleSyntax<S, SE, T>.() -> Unit)

This API is intended to simplify and add type-safety to working with sealed class states.

Executes the given block only if the current state is of the given subtype and the given predicate matches.

The block will be cancelled as soon as the state changes to a different type or the predicate does not return true. Note that this does not guarantee the operation in the block is atomic.

The state is captured and does not change within this block.

Parameters

clazz

the class of the state to match. Must be a subclass of the Container's state type.

predicate

optional predicate to match the state against. Defaults to true.

suspend fun <S : Any, T : S> Flow<S>.runOn(clazz: KClass<T>, predicate: (T) -> Boolean = { true }, 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.

Executes the given block only if the current state is of the given subtype and the given predicate matches.

The block will be cancelled as soon as the state changes to a different type or the predicate does not return true. Note that this does not guarantee the operation in the block is atomic.

The state is captured and does not change within this block.

Parameters

clazz

the class of the state to match. Must be a subclass of the Container's state type.

predicate

optional predicate to match the state against. Defaults to true.