Struct Builder

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

Available on crate feature plugin only.

Builder for the StoreCollection.

Implementations

impl<R: Runtime> StoreCollectionBuilder<R>

pub fn new() -> Self

Creates a new builder instance with default values.

pub fn autosave(self, duration: Duration) -> Self

Sets the autosave interval for all stores.

pub fn default_save_strategy(self, strategy: SaveStrategy) -> Self

Sets the default save strategy to be used by the stores.

pub fn on_load<F>(self, f: F) -> Self

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

Registers a closure to be called when a store is loaded.

pub fn path(self, path: impl AsRef<Path>) -> Self

Directory where the stores will be saved.

pub fn pretty(self, yes: bool) -> Self

Sets whether the store files should be pretty printed.

pub fn save_denylist<I, T>(self, denylist: I) -> Self

where I: IntoIterator<Item = T>, T: AsRef<str>,

Sets a list of stores that should not be saved to disk.

pub fn sync_denylist<I, T>(self, denylist: I) -> Self

where I: IntoIterator<Item = T>, T: AsRef<str>,

Sets a list of stores that should not be synchronized across windows.

pub fn migration(self, id: impl Into<StoreId>, migration: Migration) -> Self

Available on crate feature unstable-migration only.

Defines a migration for a store.

pub fn migrations<I>(self, id: impl Into<StoreId>, migrations: I) -> Self

where I: IntoIterator<Item = Migration>,

Available on crate feature unstable-migration only.

Defines multiple migrations for a store.

pub fn on_before_each_migration<F>(self, f: F) -> Self

where F: Fn(MigrationContext<'_>) + Send + Sync + 'static,

Available on crate feature unstable-migration only.

Sets a closure to be called before each migration step.

pub fn build_plugin(self) -> TauriPlugin<R>

Initializes the plugin with a StoreCollection.

Panics

Panics if a store collection is already initialized.

Trait Implementations

impl<R: Runtime> Default for StoreCollectionBuilder<R>

fn default() -> Self

Returns the “default value” for a type.