Store

Struct Store 

Source
pub struct Store<S, A: Action> { /* private fields */ }
Expand description

Centralized state store with Redux-like reducer pattern

The store holds the application state and provides a single point for state mutations through the dispatch method.

§Type Parameters

  • S - The application state type
  • A - The action type (must implement Action)

§Example

#[derive(Default)]
struct AppState {
    counter: i32,
}

#[derive(Action, Clone, Debug)]
enum MyAction {
    Increment,
    Decrement,
}

fn reducer(state: &mut AppState, action: MyAction) -> bool {
    match action {
        MyAction::Increment => {
            state.counter += 1;
            true
        }
        MyAction::Decrement => {
            state.counter -= 1;
            true
        }
    }
}

let mut store = Store::new(AppState::default(), reducer);
store.dispatch(MyAction::Increment);
assert_eq!(store.state().counter, 1);

Implementations§

Source§

impl<S, A: Action> Store<S, A>

Source

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

Create a new store with initial state and reducer

Source

pub fn dispatch(&mut self, action: A) -> bool

Dispatch an action to the store

The reducer will be called with the current state and action. Returns true if the state changed and a re-render is needed.

Source

pub fn state(&self) -> &S

Get a reference to the current state

Source

pub fn state_mut(&mut self) -> &mut S

Get a mutable reference to the state

Use this sparingly - prefer dispatching actions for state changes. This is useful for initializing state or for cases where the action pattern doesn’t fit well.

Trait Implementations§

Source§

impl<S, A: Action> DispatchStore<S, A> for Store<S, A>

Source§

fn dispatch(&mut self, action: A) -> bool

Dispatch an action and return whether the state changed.
Source§

fn state(&self) -> &S

Get the current state.

Auto Trait Implementations§

§

impl<S, A> Freeze for Store<S, A>
where S: Freeze,

§

impl<S, A> RefUnwindSafe for Store<S, A>

§

impl<S, A> Send for Store<S, A>
where S: Send,

§

impl<S, A> Sync for Store<S, A>
where S: Sync, A: Sync,

§

impl<S, A> Unpin for Store<S, A>
where S: Unpin, A: Unpin,

§

impl<S, A> UnwindSafe for Store<S, A>
where S: UnwindSafe, A: UnwindSafe,

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