Struct Store 

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

A key-value store, persisted to a file resolved with resolve_store_path.

The values are kept in memory and written to disk on Store::save, and also automatically after each modification unless auto save has been disabled with StoreBuilder::disable_auto_save. Any pending auto save is applied when the store is dropped.

Create or load one with StoreExt::store or StoreBuilder. It is a Resource, so it is also reachable from the frontend by its ResourceId; closing that resource unregisters the store, meaning the next load creates a new instance.

Implementations

impl<R: Runtime> Store<R>

pub fn set(&self, key: impl Into<String>, value: impl Into<JsonValue>)

Inserts a key-value pair into the store.

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

Returns the value for the given key or None if the key does not exist.

pub fn has(&self, key: impl AsRef<str>) -> bool

Returns true if the given key exists in the store.

pub fn delete(&self, key: impl AsRef<str>) -> bool

Removes a key-value pair from the store.

pub fn clear(&self)

Clears the store, removing all key-value pairs.

Note: To clear the storage and reset it to its default value, use reset instead.

pub fn reset(&self)

Resets the store to its default value.

If no default value has been set, this method behaves identical to clear.

pub fn keys(&self) -> Vec<String>

Returns a list of all keys in the store.

pub fn values(&self) -> Vec<JsonValue>

Returns a list of all values in the store.

pub fn entries(&self) -> Vec<(String, JsonValue)>

Returns a list of all key-value pairs in the store.

pub fn length(&self) -> usize

Returns the number of elements in the store.

pub fn is_empty(&self) -> bool

Returns true if the store contains no elements.

pub fn reload(&self) -> Result<()>

Update the store from the on-disk state

Note:

• This method loads the data and merges it with the current store, this behavior will be changed to resetting to default first and then merging with the on-disk state in v3, to fully match the store with the on-disk state, use reload_ignore_defaults instead
• This method does not emit change events

pub fn reload_ignore_defaults(&self) -> Result<()>

Load the store from the on-disk state, ignoring defaults

Note: This method does not emit change events

pub fn save(&self) -> Result<()>

Saves the store to disk at the store’s path.

pub fn close_resource(&self)

Removes the store from the resource table

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

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

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.

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.