Struct Valtio

pub struct Valtio<R: Runtime>(/* private fields */);

The Valtio plugin.

Implementations

impl<R: Runtime> Valtio<R>

pub fn clear_autosave(&self)

Stops the autosave.

pub fn default_save_strategy(&self) -> SaveStrategy

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

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

Gets a value from a store.

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

Lists all the store ids.

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

Patches a store state.

pub fn path(&self) -> &Path

Directory where the stores are saved.

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

Saves a store to the disk.

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

Saves all the stores to the disk.

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

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

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

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

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

Saves some stores to the disk.

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

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

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

Sets a key-value pair in a store.

pub fn set_autosave(&self, duration: Duration)

Saves the stores periodically.

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

Gets a clone of the store state if it exists.

pub 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 parse it as an instance of type T.

pub 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 parse it as an instance of type T.

pub fn unwatch( &self, store_id: impl AsRef<str>, listener_id: u32, ) -> Result<bool>

Removes a watcher from a store.

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

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

Watches a store for changes.

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

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

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

Trait Implementations

impl<R: Runtime> Clone for Valtio<R>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.