Struct composable::Store

pub struct Store<State: Reducer> { /* private fields */ }

The state container for the application.

Threading

Implementations

impl<State: Reducer> Store<State>

pub fn with_initial(state: State) -> Self

where State: Send + 'static, <State as Reducer>::Action: Send, <State as Reducer>::Output: Send + From<State>,

Creates a new Store with state as its initial state.

If State is not Send, then new or default can be used instead.

pub fn new<F>(with: F) -> Self

where F: FnOnce() -> State + Send + 'static, <State as Reducer>::Action: Send + 'static, <State as Reducer>::Output: Send + From<State> + 'static,

Creates a new Store with its initial state generated by a function.

Useful if State is not Send, but the arguments used to construct it are.

pub fn send(&self, action: impl Into<<State as Reducer>::Action>)

Calls the Store’s Reducer with action.

Takes an Into<Action> so that both child and parent Actions may be sent easily.

pub fn into_inner(self) -> <State as Reducer>::Output

Stops the Store’s runtime and returns its current state value.

Note

Care should be exercised when using this method in applications that utilize asynchronous Effects. into_inner makes a “best effort” to wait until any pending tasks are completed but it is not guaranteed.

Trait Implementations

impl<State> Default for Store<State>

where State: Default + Reducer, <State as Reducer>::Action: Send + 'static, <State as Reducer>::Output: Send + From<State> + 'static,

fn default() -> Self

Creates a new Store with a default initial state.