Struct tauri_plugin_store::Builder

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

Implementations

impl<R: Runtime> Builder<R>

pub fn new() -> Self

pub fn store(self, store: Store<R>) -> Self

Registers a store with the plugin.

Examples

use tauri_plugin_store::{StoreBuilder, Builder};

tauri::Builder::default()
  .setup(|app| {
    let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    let builder = Builder::default().store(store);
    Ok(())
  });

pub fn stores<T: IntoIterator<Item = Store<R>>>(self, stores: T) -> Self

Registers multiple stores with the plugin.

Examples

use tauri_plugin_store::{StoreBuilder, Builder};

tauri::Builder::default()
  .setup(|app| {
    let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    let builder = Builder::default().stores([store]);
    Ok(())
  });

pub fn freeze(self) -> Self

Freezes the collection.

This causes requests for plugins that haven’t been registered to fail

Examples

use tauri_plugin_store::{StoreBuilder, Builder};

tauri::Builder::default()
  .setup(|app| {
    let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    app.handle().plugin(Builder::default().freeze().build());
    Ok(())
  });

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

Builds the plugin.

Examples

use tauri_plugin_store::{StoreBuilder, Builder};

tauri::Builder::default()
  .setup(|app| {
    let store = StoreBuilder::new("store.bin").build(app.handle().clone());
    app.handle().plugin(Builder::default().build());
    Ok(())
  });

Trait Implementations

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

fn default() -> Self

Returns the “default value” for a type.