Struct EffectRuntime 

pub struct EffectRuntime<S, A: Action, E, St: EffectStoreLike<S, A, E> = EffectStore<S, A, E>> { /* private fields */ }

Runtime helper for effect-based stores.

Implementations

impl<S: 'static, A: Action, E> EffectRuntime<S, A, E, EffectStore<S, A, E>>

pub fn new(state: S, reducer: EffectReducer<S, A, E>) -> Self

Create a runtime from state + effect reducer.

impl<S: 'static, A: Action, E, St: EffectStoreLike<S, A, E>> EffectRuntime<S, A, E, St>

pub fn from_store(store: St) -> Self

Create a runtime from an existing effect store.

pub fn with_event_poller(self, config: PollerConfig) -> Self

Configure event polling behavior.

pub fn with_dispatch_error_handler<F>(self, handler: F) -> Self

where F: FnMut(&DispatchError) -> DispatchErrorPolicy + 'static,

Configure handling for recoverable dispatch errors.

The handler receives each DispatchError and selects a DispatchErrorPolicy. Runtimes do not log or store errors by default; do that inside this closure when needed.

pub fn subscribe_actions(&self) -> Receiver<String>

Subscribe to action name broadcasts.

Returns a receiver that will receive action names (from action.name()) whenever an action is dispatched. Useful for replay await functionality.

pub fn enqueue(&self, action: A)

Send an action into the runtime queue.

pub fn action_tx(&self) -> UnboundedSender<A>

Clone the action sender.

pub fn state(&self) -> &S

Access the current state.

pub async fn run<B, FRender, FEvent, FQuit, FEffect, R>( &mut self, terminal: &mut Terminal<B>, render: FRender, map_event: FEvent, should_quit: FQuit, handle_effect: FEffect, ) -> Result<()>

where B: Backend, FRender: FnMut(&mut Frame<'_>, Rect, &S, RenderContext), FEvent: FnMut(&EventKind, &S) -> R, R: Into<EventOutcome<A>>, FQuit: FnMut(&A) -> bool, FEffect: FnMut(E, &mut EffectContext<'_, A>),

Run the event/action loop until quit.

pub async fn run_with_bus<B, FRender, FQuit, FEffect, Id, Ctx>( &mut self, terminal: &mut Terminal<B>, bus: &mut EventBus<S, A, Id, Ctx>, keybindings: &Keybindings<Ctx>, render: FRender, should_quit: FQuit, handle_effect: FEffect, ) -> Result<()>

where B: Backend, Id: ComponentId + 'static, Ctx: BindingContext + 'static, S: EventRoutingState<Id, Ctx>, FRender: FnMut(&mut Frame<'_>, Rect, &S, RenderContext, &mut EventContext<Id>), FQuit: FnMut(&A) -> bool, FEffect: FnMut(E, &mut EffectContext<'_, A>),

Run the event/action loop using an EventBus for routing.