Signals active state of a FlowEffect. Does not contain the actions emitted by the flow. The reducer controls what to do with the emitted actions and how to incorporate them in the State.

IntegerEffectIdSource

class IntegerEffectIdSource(initalValue: Int = 1) : EffectIdSource

An EffectIdSource that generates monotonically increasing integers as ids, always incrementing by 1.

IteratorEffectIdSource

class IteratorEffectIdSource(val ids: List<EffectId>) : EffectIdSource

An EffectIdSource that iterates through a fixed list of configured EffectIds. Throws NoSuchElementException when the list has been exceeded.

OwnerId

@JvmInline

value class OwnerId(val id: String)

Reaction

sealed interface Reaction<out A : Action>

Describes a reaction to an Action that is different from changing the State.

Reducer

fun interface Reducer<S : State, A : Action>

The Reducer determines what happens in response to an Action:

Reduction

data class Reduction<S : State, A : Action>

The result of a Reducer.reduce call. Consists of:

State

interface State

Store

class Store<S : State, A : Action>(reducer: Reducer<S, A>, initialState: S, coroutineDispatcher: CoroutineDispatcher = Dispatchers.Default, coroutineScopeName: String = DEFAULT_COROUTINE_SCOPE_NAME, effectIdSource: EffectIdSource = UUIDEffectIdSource(), logger: Logger = NoopLogger(), exceptionHandler: ExceptionHandler = ThrowingExceptionHandler, parentJob: Job? = null) : AutoCloseable

A construct for managing complex state safely in concurrent environments.

ThrowingExceptionHandler

object ThrowingExceptionHandler : ExceptionHandler

UUIDEffectIdSource

class UUIDEffectIdSource : EffectIdSource

An EffectIdSource that generates random Uuids as EffectIds.

Functions

effect

fun <A : Action> effect(effectId: EffectId, triggerAction: A, ownerId: OwnerId? = null, block: suspend () -> A): Effect<A>

Effect builder function.

emittedValueOrElse

fun <R> FlowEffectEvent<R>.emittedValueOrElse(orElse: () -> R): R

fun <R, T> FlowEffectEvent<R>.emittedValueOrElse(valueTransformer: (R) -> T, orElse: () -> T): T

flowEffect

fun <A : Action> flowEffect(effectId: EffectId, triggerAction: A, ownerId: OwnerId? = null, block: suspend () -> Flow<A>): FlowEffect<A>

isCompleted

fun EffectState<*>.isCompleted(): Boolean

isFailed

fun EffectState<*>.isFailed(): Boolean

isRunning

fun EffectState<*>.isRunning(): Boolean

matchesActionType

inline fun <A : Action> EffectState<*>.matchesActionType(): Boolean

toEffectId

fun String.toEffectId(): EffectId

toFlowEffectState

fun <R> FlowEffectEvent<R>.toFlowEffectState(): FlowEffectState

toOwnerId

fun String.toOwnerId(): OwnerId

trackedEffect

fun <A : Action, R, C : A> trackedEffect(effectId: EffectId, triggerAction: A, actionWrapper: (EffectState<R>) -> C, ownerId: OwnerId? = null, block: suspend () -> R): FlowEffect<A>

trackedFlowEffect

fun <A : Action, R, C : A> trackedFlowEffect(effectId: EffectId, triggerAction: A, actionWrapper: (FlowEffectEvent<R>) -> C, ownerId: OwnerId? = null, block: suspend () -> Flow<R>): FlowEffect<A>