Struct Store

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

Implementations

impl<R: Runtime> Store<R>

pub fn id(&self) -> &str

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 state(&self) -> &StoreState

Gets a reference to the store state.

pub fn try_state<T: DeserializeOwned>(&self) -> Result<T>

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

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

Gets a value from the store.

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

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

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 = &Json>

Creates an iterator over the store values.

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

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_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 set_options_with_source<S>( &mut self, options: StoreOptions, source: S, ) -> Result<()>

where S: Into<EventSource>,

Sets the store options, optionally having a window as the source.

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

Sets the store options.

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

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

Watches the store for changes.

pub fn unwatch(&mut self, id: u32) -> bool

Removes a listener from this store.

impl<R: Runtime> Store<R>

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

Sets a key-value pair in the store.

pub fn patch_with_source<S>( &mut self, state: StoreState, source: S, ) -> Result<()>

where S: Into<EventSource>,

Patches the store state, optionally having a window as the source.

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

Patches the store state.

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

Save the store state to the disk.

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

Save the store immediately, ignoring the save strategy.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<R: Runtime> From<&Store<R>> for StoreOptions

fn from(store: &Store<R>) -> Self

Converts to this type from the input type.