tauri-store 1.2.2

Persistent 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
48
49

use crate::collection::StoreCollection;
use crate::error::Result;
use crate::store::Store;
use crate::{CollectionMarker, DefaultMarker};
use tauri::{Manager, Runtime, State};

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

  /// Returns a handle to the store collection for the specified marker.
  ///
  /// # Panics
  ///
  /// Panics if the [store collection] is not yet being managed by Tauri.
  ///
  /// This likely indicates it was called before the plugin was properly initialized.
  ///
  /// [store collection]: https://docs.rs/tauri-store/latest/tauri_store/struct.StoreCollection.html
  fn store_collection_with_marker<C>(&self) -> State<'_, StoreCollection<R, C>>
  where
    C: CollectionMarker,
  {
    self.app_handle().state::<StoreCollection<R, C>>()
  }

  /// 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, DefaultMarker>) -> T,
  {
    self.store_collection().with_store(id, f)
  }
}

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