Struct Store

pub struct Store<T, S = SyncStorage> { /* private fields */ }

An arena-allocated container for a reactive store.

The type T should be a struct that has been annotated with #[derive(Store)].

This adds a getter method for each field to Store<T>, which allow accessing reactive versions of each individual field of the struct.

This follows the same ownership rules as arena-allocated types like RwSignal.

Implementations

impl<T> Store<T>

where T: Send + Sync + 'static,

pub fn new(value: T) -> Self

Creates a new store with the initial value.

impl<T> Store<T, LocalStorage>

where T: 'static,

pub fn new_local(value: T) -> Self

Creates a new store for a type that is !Send.

This pins the value to the current thread. Accessing it from any other thread will panic.

Trait Implementations

impl<T, S> Clone for Store<T, S>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, S> Debug for Store<T, S>

where S: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for Store<T>

where T: Default + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Default for Store<T, LocalStorage>

where T: Default + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<T, S> DefinedAt for Store<T, S>

fn defined_at(&self) -> Option<&'static Location<'static>>

Returns the location at which the signal was defined. This is usually simply None in release mode.

impl<T, S> Dispose for Store<T, S>

where T: 'static,

fn dispose(self)

Disposes of the signal. This:

impl<T, S> From<ArcStore<T>> for Store<T, S>

where T: 'static, S: Storage<ArcStore<T>>,

fn from(value: ArcStore<T>) -> Self

Converts to this type from the input type.

impl<T, S> From<Store<T, S>> for ArcField<T>

where T: 'static, S: Storage<ArcStore<T>>,

fn from(value: Store<T, S>) -> Self

Converts to this type from the input type.

impl<T, S> From<Store<T, S>> for Field<T, S>

where T: 'static, S: Storage<ArcStore<T>> + Storage<ArcField<T>>,

fn from(value: Store<T, S>) -> Self

Converts to this type from the input type.

impl<T, S> IsDisposed for Store<T, S>

where T: 'static,

fn is_disposed(&self) -> bool

If true, the signal cannot be accessed without a panic.

impl<T, S> Notify for Store<T, S>

where T: 'static, S: Storage<ArcStore<T>>,

fn notify(&self)

Notifies subscribers of a change in this signal.

impl<T, S> PartialEq for Store<T, S>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, S> ReadUntracked for Store<T, S>

where T: 'static, S: Storage<ArcStore<T>>,

type Value = ReadGuard<T, Plain<T>>

The guard type that will be returned, which can be dereferenced to the value.

fn try_read_untracked(&self) -> Option<Self::Value>

Returns the guard, or None if the signal has already been disposed.

fn read_untracked(&self) -> Self::Value

Returns the guard.

fn custom_try_read(&self) -> Option<Option<Self::Value>>

This is a backdoor to allow overriding the Read::try_read implementation despite it being auto implemented.

impl<T, S> StoreField for Store<T, S>

where T: 'static, S: Storage<ArcStore<T>>,

type Value = T

The value this field contains.

type Reader = Plain<T>

A read guard to access this field.

type Writer = WriteGuard<ArcTrigger, UntrackedWriteGuard<T>>

A write guard to update this field.

fn get_trigger(&self, path: StorePath) -> StoreFieldTrigger

Returns the trigger that tracks access and updates for this field.

fn path(&self) -> impl IntoIterator<Item = StorePathSegment>

The path of this field (see StorePath).

fn reader(&self) -> Option<Self::Reader>

Returns a read guard to access this field.

fn writer(&self) -> Option<Self::Writer>

Returns a write guard to update this field.

fn keys(&self) -> Option<KeyMap>

The keys for this field, if it is a keyed field.

fn track_field(&self)

Reactively tracks this field.

fn triggers_for_current_path(&self) -> Vec<ArcTrigger>

Returns triggers for this field, and all parent fields.

fn triggers_for_path(&self, path: StorePath) -> Vec<ArcTrigger>

Returns triggers for the field at the given path, and all parent fields

impl<T, S> Track for Store<T, S>

where T: 'static, S: Storage<ArcStore<T>>,

fn track(&self)

Subscribes to this signal in the current reactive scope without doing anything with its value.

impl<T, S> Write for Store<T, S>

where T: 'static, S: Storage<ArcStore<T>>,

type Value = T

The type of the signal’s value.

fn try_write(&self) -> Option<impl UntrackableGuard<Target = Self::Value>>

Returns the guard, or None if the signal has already been disposed.

fn try_write_untracked(&self) -> Option<impl DerefMut<Target = Self::Value>>

or None if the signal has already been disposed.

fn write(&self) -> impl UntrackableGuard

Returns the guard.

fn write_untracked(&self) -> impl DerefMut

Returns a guard that will not notify subscribers when dropped.

impl<T, S> Copy for Store<T, S>

impl<T, S> Eq for Store<T, S>