Struct StoreCollection

pub struct StoreCollection<R, C>
where
    R: Runtime,
    C: CollectionMarker,
{ /* private fields */ }

A collection of stores. This is the core component for store plugins.

Implementations

impl<R, C> StoreCollection<R, C>

where R: Runtime, C: CollectionMarker,

pub fn path(&self) -> PathBuf

Directory where the stores are saved.

pub fn set_path(&self, path: impl AsRef<Path>) -> Result<(), Error>

Sets the directory where the stores are saved. This will move all currently active stores to the new directory.

impl<R, C> StoreCollection<R, C>

where R: Runtime, C: CollectionMarker,

pub fn builder() -> StoreCollectionBuilder<R, C>

Builds a new store collection.

pub fn ids(&self) -> Vec<StoreId>

Lists all the store ids.

pub fn with_store<F, T>( &self, store_id: impl AsRef<str>, f: F, ) -> Result<T, Error>

where F: FnOnce(&mut Store<R, C>) -> T,

Calls a closure with a mutable reference to the store with the given id.

pub fn state(&self, store_id: impl AsRef<str>) -> Result<StoreState, Error>

Gets a clone of the store state.

pub fn try_state<T>(&self, store_id: impl AsRef<str>) -> Result<T, Error>

where T: DeserializeOwned,

Gets the store state, then tries to parse it as an instance of type T.

pub fn try_state_or<T>( &self, store_id: impl AsRef<str>, default: T, ) -> Result<T, Error>

where T: DeserializeOwned,

Gets the store state, then tries to parse it as an instance of type T.

If it cannot be parsed, returns the provided default value.

pub fn try_state_or_default<T>( &self, store_id: impl AsRef<str>, ) -> Result<T, Error>

where T: DeserializeOwned + Default,

Gets the store state, then tries to parse it as an instance of type T.

If it cannot be parsed, returns the default value of T.

pub fn try_state_or_else<T>( &self, store_id: impl AsRef<str>, f: impl FnOnce() -> T, ) -> Result<T, Error>

where T: DeserializeOwned,

Gets the store state, then tries to parse it as an instance of type T.

If it cannot be parsed, returns the result of the provided closure.

pub fn get( &self, store_id: impl AsRef<str>, key: impl AsRef<str>, ) -> Option<Value>

Gets a value from a store.

pub fn try_get<T>( &self, store_id: impl AsRef<str>, key: impl AsRef<str>, ) -> Result<T, Error>

where T: DeserializeOwned,

Gets a value from a store and tries to parse it as an instance of type T.

pub fn try_get_or<T>( &self, store_id: impl AsRef<str>, key: impl AsRef<str>, default: T, ) -> T

where T: DeserializeOwned,

Gets a value from a store and tries to parse it as an instance of type T.

If the key does not exist, returns the provided default value.

pub fn try_get_or_default<T>( &self, store_id: impl AsRef<str>, key: impl AsRef<str>, ) -> T

where T: Default + DeserializeOwned,

Gets a value from a store and tries to parse it as an instance of type T.

If the key does not exist, returns the default value of T.

pub fn try_get_or_else<T>( &self, store_id: impl AsRef<str>, key: impl AsRef<str>, f: impl FnOnce() -> T, ) -> T

where T: DeserializeOwned,

Gets a value from a store and tries to parse it as an instance of type T.

If the key does not exist, returns the result of the provided closure.

pub fn set<K, V>( &self, store_id: impl AsRef<str>, key: K, value: V, ) -> Result<(), Error>

where K: AsRef<str>, V: Into<Value>,

Sets a key-value pair in a store.

pub fn patch<S>(&self, store_id: impl AsRef<str>, state: S) -> Result<(), Error>

where S: Into<StoreState>,

Patches a store state.

pub fn save(&self, store_id: impl AsRef<str>) -> Result<(), Error>

Saves a store to the disk.

pub fn save_now(&self, store_id: impl AsRef<str>) -> Result<(), Error>

Saves a store to the disk immediately, ignoring the save strategy.

pub fn save_some(&self, ids: &[impl AsRef<str>]) -> Result<(), Error>

Saves some stores to the disk.

pub fn save_some_now(&self, ids: &[impl AsRef<str>]) -> Result<(), Error>

Saves some stores to the disk immediately, ignoring the save strategy.

pub fn save_all(&self) -> Result<(), Error>

Saves all the stores to the disk.

pub fn save_all_now(&self) -> Result<(), Error>

Saves all the stores to the disk immediately, ignoring the save strategy.

pub fn default_save_strategy(&self) -> SaveStrategy

Default save strategy for the stores. This can be overridden on a per-store basis.

pub fn set_autosave(&self, duration: Duration)

Saves the stores periodically.

pub fn clear_autosave(&self)

Stops the autosave.

pub fn watch<F>( &self, store_id: impl AsRef<str>, f: F, ) -> Result<WatcherId, Error>

where F: Fn(AppHandle<R>) -> Result<(), Error> + Send + Sync + 'static,

Watches a store for changes.

pub fn unwatch( &self, store_id: impl AsRef<str>, watcher_id: impl Into<WatcherId>, ) -> Result<bool, Error>

Removes a watcher from a store.

pub fn allow_save(&self, id: impl AsRef<str>)

Removes a store from the save denylist.

pub fn deny_save(&self, id: impl AsRef<str>)

Adds a store to the save denylist.

pub fn allow_sync(&self, id: impl AsRef<str>)

Removes a store from the sync denylist.

pub fn deny_sync(&self, id: impl AsRef<str>)

Adds a store to the deny denylist.

Trait Implementations

impl<R, C> Debug for StoreCollection<R, C>

where R: Runtime, C: CollectionMarker,

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

Formats the value using the given formatter.

impl<R, C> Resource for StoreCollection<R, C>

where R: Runtime, C: CollectionMarker,

fn name(&self) -> Cow<'_, str>

Returns a string representation of the resource. The default implementation returns the Rust type name, but specific resource types may override this trait method.

fn close(self: Arc<Self>)

Resources may implement the close() trait method if they need to do resource specific clean-ups, such as cancelling pending futures, after a resource has been removed from the resource table.