Cleanup

Author: Leinnan

crates/eframe/src/epi.rs

@@ -202,8 +202,8 @@ pub trait App {
     ///
     /// On web the state is stored to "Local Storage".
     ///
-    /// On native the path is picked using [`crate::storage_dir`].
-    /// The path can be customized via [`NativeOptions::persistence_path`].
+    /// On native by default the path is picked using [`crate::storage_dir`].
+    /// The path can be customized via [`NativeOptions::storage_build`].
     fn save(&mut self, _storage: &mut dyn Storage) {}
 
     /// Called once on shutdown, after [`Self::save`].
@@ -294,12 +294,15 @@ pub enum HardwareAcceleration {
 #[derive(Default, Clone)]
 pub enum StorageProvider {
     #[default]
-    /// eframe will use a default
+    /// `eframe` will use a default
     /// data storage path for each target system.
+    /// The path is picked using [`crate::storage_dir`].
     Default,
+
     /// `eframe` will store the app state in the specified file in the ron format.
     /// On web builds, this will behave the same as [`Self::Default`].
     AtPath(std::path::PathBuf),
+
     /// Custom storage provider.
     /// It allows specifying function that will be called during context creation to provide
     Custom(fn(&str) -> Option<Box<dyn Storage>>),
@@ -499,7 +502,7 @@ impl Default for NativeOptions {
 
             persist_window: true,
 
-            storage_build: StorageProviderBuild::Default,
+            storage_build: StorageProvider::Default,
 
             dithering: true,
 
@@ -587,7 +590,7 @@ impl Default for WebOptions {
             should_prevent_default: Box::new(|_| true),
 
             max_fps: None,
-            storage_build: StorageProviderBuild::Default,
+            storage_build: StorageProvider::Default,
         }
     }
 }

crates/eframe/src/native/epi_integration.rs

@@ -151,9 +151,9 @@ impl epi::StorageProvider {
     /// Not available on wasm32. For web, use `try_create_storage_web`.
     pub fn try_create_storage(&self, app_name: &str) -> Option<Box<dyn epi::Storage>> {
         match self {
-            epi::StorageProviderBuild::Default => create_storage(app_name),
-            epi::StorageProviderBuild::AtPath(path) => create_storage_with_file(path),
-            epi::StorageProviderBuild::Custom(f) => f(app_name),
+            epi::StorageProvider::Default => create_storage(app_name),
+            epi::StorageProvider::AtPath(path) => create_storage_with_file(path),
+            epi::StorageProvider::Custom(f) => f(app_name),
         }
     }
 }

crates/eframe/src/web/app_runner.rs

@@ -430,10 +430,10 @@ impl epi::StorageProvider {
     /// For loading/saving app state and/or egui memory to disk.
     pub fn try_create_storage_web(&self, app_name: &str) -> Option<Box<dyn epi::Storage>> {
         match self {
-            epi::StorageProviderBuild::Default | epi::StorageProviderBuild::AtPath(_) => {
+            epi::StorageProvider::Default | epi::StorageProvider::AtPath(_) => {
                 Some(Box::new(LocalStorage::default()))
             }
-            epi::StorageProviderBuild::Custom(f) => f(app_name),
+            epi::StorageProvider::Custom(f) => f(app_name),
         }
     }
 }

examples/custom_storage/src/main.rs

@@ -4,15 +4,15 @@
 use std::path::PathBuf;
 
 use eframe::{
-    Storage, StorageProviderBuild,
+    Storage, StorageProvider,
     egui::{self, ahash::HashMap},
 };
 
 fn main() -> eframe::Result {
     env_logger::init(); // Log to stderr (if you run with `RUST_LOG=debug`).
     let options = eframe::NativeOptions {
         viewport: egui::ViewportBuilder::default().with_inner_size([350.0, 590.0]),
-        storage_build: StorageProviderBuild::Custom(custom_storage),
+        storage_build: StorageProvider::Custom(custom_storage),
         ..Default::default()
     };
     eframe::run_native(