Struct StoreCollection

pub struct StoreCollection<R: Runtime> { /* private fields */ }

Implementations

impl<R: Runtime> StoreCollection<R>

pub fn builder() -> StoreCollectionBuilder

pub fn path(&self) -> &Path

Directory where the stores are saved.

pub fn with_store<F, T>( &self, id: impl AsRef<str>, f: F, ) -> BoxFuture<'_, Result<T>>

where F: FnOnce(&mut Store<R>) -> BoxFuture<'_, Result<T>> + Send + 'static, T: Send + 'static,

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

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

Saves a store to the disk.

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

Saves some stores to the disk.

pub async fn save_all(&self) -> Result<()>

Saves all the stores to the disk.

pub async fn ids(&self) -> Vec<String>

Lists all the store ids.

pub async fn store_state(&self, store_id: impl AsRef<str>) -> Option<StoreState>

Gets a clone of the store state if it exists.

WARNING: Changes to the returned state will not be reflected in the store.

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

where T: DeserializeOwned,

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

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

Gets a value from a store.

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

where T: DeserializeOwned,

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

pub async fn set( &self, store_id: impl AsRef<str>, key: impl AsRef<str>, value: Json, ) -> Result<()>

Sets a key-value pair in a store.

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

Patches a store state.

pub fn enable_sync(&self, store_id: impl AsRef<str>)

Remove a store from the sync denylist.

pub fn disable_sync(&self, store_id: impl AsRef<str>)

Add a store to the sync denylist.

pub fn set_autosave(&self, duration: Duration)

Available on crate feature unstable-async only.

Saves the stores periodically.

pub fn clear_autosave(&self)

Available on crate feature unstable-async only.

Stops the autosave.

pub async fn unload_store(&self, id: &str) -> Result<()>

Trait Implementations

impl<R: Runtime> Debug for StoreCollection<R>

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

Formats the value using the given formatter.

impl<R: Runtime> Drop for StoreCollection<R>

fn drop(&mut self)

Executes the destructor for this type.

impl<R: Runtime> Resource for StoreCollection<R>

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.