Struct EffectRuntime 

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

Runtime helper for effect-based stores.

Implementations

impl<S, A, E> EffectRuntime<S, A, E>

where S: 'static, A: Action,

pub fn new( state: S, reducer: fn(&mut S, A) -> ReducerResult<E>, ) -> EffectRuntime<S, A, E>

Create a runtime from state + effect reducer.

impl<S, A, E, St> EffectRuntime<S, A, E, St>

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

pub fn from_store(store: St) -> EffectRuntime<S, A, E, St>

Create a runtime from an existing effect store.

pub fn with_debug<D>(self, debug: D) -> EffectRuntime<S, A, E, St>

where D: DebugAdapter<S, A> + DebugHooks<A>,

Attach a debug layer (auto-wires tasks/subscriptions when available).

pub fn with_event_poller( self, config: PollerConfig, ) -> EffectRuntime<S, A, E, St>

Configure event polling behavior.

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<(), Error>

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<(), Error>

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.