EffectRuntime

Struct EffectRuntime 

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

Runtime helper for effect-based stores.

Implementations§

Source§

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

Source

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

Create a runtime from state + effect reducer.

Source§

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

Source

pub fn from_store(store: St) -> Self

Create a runtime from an existing effect store.

Source

pub fn with_debug(self, debug: DebugLayer<A>) -> Self
where S: DebugState, A: ActionParams,

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

Source

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

Configure event polling behavior.

Source

pub fn enqueue(&self, action: A)

Send an action into the runtime queue.

Source

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

Clone the action sender.

Source

pub fn state(&self) -> &S

Access the current state.

Source

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.

Auto Trait Implementations§

§

impl<S, A, E, St> Freeze for EffectRuntime<S, A, E, St>
where St: Freeze,

§

impl<S, A, E, St = EffectStore<S, A, E>> !RefUnwindSafe for EffectRuntime<S, A, E, St>

§

impl<S, A, E, St = EffectStore<S, A, E>> !Send for EffectRuntime<S, A, E, St>

§

impl<S, A, E, St = EffectStore<S, A, E>> !Sync for EffectRuntime<S, A, E, St>

§

impl<S, A, E, St> Unpin for EffectRuntime<S, A, E, St>
where St: Unpin, S: Unpin, E: Unpin,

§

impl<S, A, E, St = EffectStore<S, A, E>> !UnwindSafe for EffectRuntime<S, A, E, St>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more