Struct Store 

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

A key-value store that can persist its state to disk.

Implementations

impl<R, C> Store<R, C>

where R: Runtime, C: CollectionMarker,

pub fn id(&self) -> StoreId

The id of the store.

pub fn path(&self) -> PathBuf

Path to the store file.

pub fn app_handle(&self) -> &AppHandle<R>

Gets a handle to the application instance.

pub fn raw_state(&self) -> &StoreState

Gets a reference to the raw store state.

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

where T: DeserializeOwned,

Tries to parse the store state as an instance of type T.

pub fn state_or<T>(&self, default: T) -> T

where T: DeserializeOwned,

Tries to parse the store state as an instance of type T.

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

pub fn state_or_default<T>(&self) -> T

where T: DeserializeOwned + Default,

Tries to parse the store state as an instance of type T.

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

pub fn state_or_else<T>(&self, f: impl FnOnce() -> T) -> T

where T: DeserializeOwned,

Tries to parse the store state as an instance of type T.

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

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

Gets a reference to a raw value from the store.

pub unsafe fn get_raw_unchecked(&self, key: impl AsRef<str>) -> &Value

Gets a reference to a raw value from the store.

Safety

This is undefined behavior if the key doesn’t exist in the store.

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

where T: DeserializeOwned,

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

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

where T: DeserializeOwned,

Gets a value from the 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 get_or_default<T>(&self, key: impl AsRef<str>) -> T

where T: DeserializeOwned + Default,

Gets a value from the 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 get_or_else<T>(&self, key: impl AsRef<str>, f: impl FnOnce() -> T) -> T

where T: DeserializeOwned,

Gets a value from the 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 unsafe fn get_unchecked<T>(&self, key: impl AsRef<str>) -> T

where T: DeserializeOwned,

Gets a value from the store and parses it as an instance of type T.

Safety

This is undefined behavior if the key doesn’t exist in the store OR if the value cannot be represented as a valid T.

pub fn set( &mut self, key: impl AsRef<str>, value: impl Into<Value>, ) -> Result<(), Error>

Sets a key-value pair in the store.

pub fn patch<S>(&mut self, state: S) -> Result<(), Error>

where S: Into<StoreState>,

Patches the store state.

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

Whether the store has a key.

pub fn keys(&self) -> impl Iterator<Item = &String>

Creates an iterator over the store keys.

pub fn values(&self) -> impl Iterator<Item = &Value>

Creates an iterator over the store values.

pub fn entries(&self) -> impl Iterator<Item = (&String, &Value)>

Creates an iterator over the store entries.

pub fn len(&self) -> usize

Returns the amount of items in the store.

pub fn is_empty(&self) -> bool

Whether the store is empty.

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

Save the store state to the disk.

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

Save the store immediately, ignoring the save strategy.

pub fn save_on_exit(&mut self, enabled: bool)

Whether to save the store on exit. This is enabled by default.

pub fn save_on_change(&mut self, enabled: bool)

Whether to save the store on state change.

pub fn save_strategy(&self) -> SaveStrategy

Current save strategy used by this store.

pub fn set_save_strategy(&mut self, strategy: SaveStrategy)

Sets the save strategy for this store. Calling this will abort any pending save operation.

pub fn watch<F>(&mut self, f: F) -> WatcherId

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

Watches the store for changes.

pub fn unwatch(&mut self, id: impl Into<WatcherId>) -> bool

Removes a listener from this store.

pub fn set_options(&mut self, options: StoreOptions) -> Result<(), Error>

Sets the store options.

Trait Implementations

impl<R, C> Debug for Store<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> From<&Store<R, C>> for StoreOptions

where R: Runtime, C: CollectionMarker,

fn from(store: &Store<R, C>) -> StoreOptions

Converts to this type from the input type.