tauri-plugin-valtio 3.0.0

Persistent Valtio stores for Tauri
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

// THIS FILE WAS AUTOGENERATED AND SHOULD NOT BE EDITED MANUALLY.
//
// Check the `codegen` command in the `tauri-store-cli` crate.
// https://github.com/ferreira-tb/tauri-store/tree/main/crates/tauri-store-cli
//
// To modify the behavior of the plugin, you must either change the
// upstream `tauri-store` crate or update the code generation itself.
// This ensures that all plugins maintain consistent behavior.

use crate::valtio::{Valtio, ValtioMarker};
use tauri::{Manager, Runtime};
use tauri_store::{ManagerExt as _, Result, Store};

/// Extension for the [`Manager`] trait providing access to the Valtio plugin.
///
/// [`Manager`]: https://docs.rs/tauri/latest/tauri/trait.Manager.html
pub trait ManagerExt<R: Runtime>: Manager<R> {
  /// Returns a handle to the Valtio plugin.
  ///
  /// # Panics
  ///
  /// Panics if the internal [store collection] is not yet being managed by Tauri.
  ///
  /// This likely indicates that it was called before the plugin was properly initialized.
  ///
  /// [store collection]: https://docs.rs/tauri-store/latest/tauri_store/struct.StoreCollection.html
  fn valtio(&self) -> Valtio<'_, R> {
    Valtio(
      self
        .app_handle()
        .store_collection_with_marker::<ValtioMarker>(),
    )
  }

  /// Calls a closure with a mutable reference to the store with the given id.
  fn with_store<F, T>(&self, id: impl AsRef<str>, f: F) -> Result<T>
  where
    F: FnOnce(&mut Store<R, ValtioMarker>) -> T,
  {
    self
      .app_handle()
      .store_collection_with_marker::<ValtioMarker>()
      .with_store(id, f)
  }
}

impl<R: Runtime, T: Manager<R>> ManagerExt<R> for T {}