3.0.0

hurok-base/com.ekezet.hurok/Loop

Loop

abstract class Loop<out TState : Any, TModel : Any, in TArgs, TDependency, in TAction : Action<TModel, TDependency>>(model: TModel, renderer: Renderer<TState, TModel>, args: TArgs? = null, argsApplyer: ArgsApplyer<TModel, TArgs>? = null, onStart: ActionEmitter<TModel, TDependency>.() -> Unit = {}, dependency: TDependency? = null, effectContext: CoroutineContext = Dispatchers.IO) : ActionEmitter<TModel, TDependency>

Base class that handles unidirectional data flow.

Parameters

model

the initial model

renderer

transform model into state

args

input arguments

argsApplyer

method to apply new args to the model

onStart

block to run before beginning to collect the loop actions

dependency

dependency container

effectContext

dispatcher for launching effects

Inheritors

Constructors

constructor(model: TModel, renderer: Renderer<TState, TModel>, args: TArgs? = null, argsApplyer: ArgsApplyer<TModel, TArgs>? = null, onStart: ActionEmitter<TModel, TDependency>.() -> Unit = {}, dependency: TDependency? = null, effectContext: CoroutineContext = Dispatchers.IO)

Properties

val <TState : Any, TModel : Any, TArgs : TModel, TDependency, TAction : Action<TModel, TDependency>> Loop<TState, TModel, TArgs, TDependency, TAction>.firstState: TState

The first state of this com.ekezet.hurok.Loop in a blocking fashion. Useful for testing.

val state: Flow<TState>

The current state produced by this loop

Functions

fun applyArgs(args: TArgs & Any): Loop<TState, TModel, TArgs, TDependency, TAction>

Apply new arguments to this loop.

fun <TState : Any, TModel : Any, TArgs, TDependency, TAction : Action<TModel, TDependency>, TLoopBuilder : LoopBuilder<TState, TModel, TArgs, TDependency, TAction>> Loop<TState, TModel, TArgs, TDependency, TAction>.asBuilder(): TLoopBuilder

fun attachTo(parent: AnyActionEmitter)

Attach this loop as a child to another loop.

override fun emit(action: Action<TModel, TDependency>)

Emit an action to change the state or trigger an effect.

fun startIn(scope: CoroutineScope): Job

Start the loop in the given scope.