use std::{ collections::HashMap, io::Write, path::{Path, PathBuf}, }; /// The folder where `eframe` will store its state. /// /// The given `app_id` is either [`crate::NativeOptions::app_id`] or /// the title argument to [`crate::run_native`]. /// /// On native the path is picked using [`directories_next::ProjectDirs::data_dir`](https://docs.rs/directories-next/2.0.0/directories_next/struct.ProjectDirs.html#method.data_dir) which is: /// * Linux: `/home/UserName/.local/share/APP_ID` /// * macOS: `/Users/UserName/Library/Application Support/APP_ID` /// * Windows: `C:\Users\UserName\AppData\Roaming\APP_ID` pub fn storage_dir(app_id: &str) -> Option { directories_next::ProjectDirs::from("", "", app_id) .map(|proj_dirs| proj_dirs.data_dir().to_path_buf()) } // ---------------------------------------------------------------------------- /// A key-value store backed by a [RON](https://github.com/ron-rs/ron) file on disk. /// Used to restore egui state, glium window position/size and app state. pub struct FileStorage { ron_filepath: PathBuf, kv: HashMap, dirty: bool, last_save_join_handle: Option>, } impl Drop for FileStorage { fn drop(&mut self) { if let Some(join_handle) = self.last_save_join_handle.take() { crate::profile_scope!("wait_for_save"); join_handle.join().ok(); } } } impl FileStorage { /// Store the state in this .ron file. fn from_ron_filepath(ron_filepath: impl Into) -> Self { crate::profile_function!(); let ron_filepath: PathBuf = ron_filepath.into(); log::debug!("Loading app state from {:?}…", ron_filepath); Self { kv: read_ron(&ron_filepath).unwrap_or_default(), ron_filepath, dirty: false, last_save_join_handle: None, } } /// Find a good place to put the files that the OS likes. pub fn from_app_id(app_id: &str) -> Option { crate::profile_function!(app_id); if let Some(data_dir) = storage_dir(app_id) { if let Err(err) = std::fs::create_dir_all(&data_dir) { log::warn!( "Saving disabled: Failed to create app path at {:?}: {}", data_dir, err ); None } else { Some(Self::from_ron_filepath(data_dir.join("app.ron"))) } } else { log::warn!("Saving disabled: Failed to find path to data_dir."); None } } } impl crate::Storage for FileStorage { fn get_string(&self, key: &str) -> Option { self.kv.get(key).cloned() } fn set_string(&mut self, key: &str, value: String) { if self.kv.get(key) != Some(&value) { self.kv.insert(key.to_owned(), value); self.dirty = true; } } fn flush(&mut self) { if self.dirty { crate::profile_function!(); self.dirty = false; let file_path = self.ron_filepath.clone(); let kv = self.kv.clone(); if let Some(join_handle) = self.last_save_join_handle.take() { // wait for previous save to complete. join_handle.join().ok(); } match std::thread::Builder::new() .name("eframe_persist".to_owned()) .spawn(move || { save_to_disk(&file_path, &kv); }) { Ok(join_handle) => { self.last_save_join_handle = Some(join_handle); } Err(err) => { log::warn!("Failed to spawn thread to save app state: {err}"); } } } } } fn save_to_disk(file_path: &PathBuf, kv: &HashMap) { crate::profile_function!(); if let Some(parent_dir) = file_path.parent() { if !parent_dir.exists() { if let Err(err) = std::fs::create_dir_all(parent_dir) { log::warn!("Failed to create directory {parent_dir:?}: {err}"); } } } match std::fs::File::create(file_path) { Ok(file) => { let mut writer = std::io::BufWriter::new(file); let config = Default::default(); if let Err(err) = ron::ser::to_writer_pretty(&mut writer, &kv, config) .and_then(|_| writer.flush().map_err(|err| err.into())) { log::warn!("Failed to serialize app state: {}", err); } else { log::trace!("Persisted to {:?}", file_path); } } Err(err) => { log::warn!("Failed to create file {file_path:?}: {err}"); } } } // ---------------------------------------------------------------------------- fn read_ron(ron_path: impl AsRef) -> Option where T: serde::de::DeserializeOwned, { crate::profile_function!(); match std::fs::File::open(ron_path) { Ok(file) => { let reader = std::io::BufReader::new(file); match ron::de::from_reader(reader) { Ok(value) => Some(value), Err(err) => { log::warn!("Failed to parse RON: {}", err); None } } } Err(_err) => { // File probably doesn't exist. That's fine. None } } }