More docs for StoreBuilder::build

tauri-apps · Oct 3, 2024 · fc51b3d · fc51b3d
1 parent 50ab4c1
commit fc51b3d
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/plugins/store/src/store.rs b/plugins/store/src/store.rs
@@ -213,6 +213,14 @@ impl<R: Runtime> StoreBuilder<R> {
 
     /// Builds the [`Store`].
     ///
+    /// This loads the store from disk and put the store in the app's resource table,
+    /// to remove it from the resource table, call [`Store::close_store`]
+    ///
+    /// # Errors
+    ///
+    /// If a store with this path is already in the resource table,
+    /// will return a [`crate::Error::AlreadyExists`]
+    ///
     /// # Examples
     /// ```
     /// tauri::Builder::default()