Struct Store

pub struct Store<S> { /* private fields */ }

A store is where your “state” data lives. It is in essence a big RefCell. There are also supporting mechanisms to enable subscriptions and mutation notifications.

Implementations

impl<S> Store<S>

pub fn new(data: S) -> Self

Create a new store with the given data. This puts the data in a RefCell and set up all the change listening mechanisms.

impl<S: Trackable> Store<S>

pub fn build_path(&self) -> StoreRoot<'_, S>

Use this method to create paths to different pieces of your state.

#[derive(Trackable)]
#[track(deep)]
struct MyStruct<T> {
    field_1: T,
    field_2: u64
}
let store = Store::new(MyStruct {
    field_1: MyStruct {
        field_1: String::new(),
        field_2: 123
    },
    field_2: 456
});

// path to the root `MyStruct` itself
let path = store.build_path();

// path to `field_1` in the root `MyStruct`
let path = store.build_path().field_1();

// path to `field_2` in the root `MyStruct`
let path = store.build_path().field_2();

// path root -> field_1 -> field_1
let path = store.build_path().field_1().field_1();

// path root -> field_1 -> field_2
let path = store.build_path().field_1().field_2();