bevy-settings 0.19.0

User settings framework for Bevy Engine
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

use bevy_log::error;
use bevy_tasks::IoTaskPool;
use web_sys::window;

/// Persistent storage which uses browser local storage.
pub(crate) struct SettingsStore {
    app_name: String,
}

impl SettingsStore {
    /// Construct a new settings store for browser local storage.
    ///
    /// # Arguments
    /// * `app_name` - The name of the application. See [`crate::SettingsPlugin`] for usage.
    pub fn new(app_name: &str) -> Self {
        Self {
            app_name: app_name.to_owned(),
        }
    }

    /// Returns the storage key for a given filename. This consists of the app name combined
    /// with the filename.
    fn storage_key(&self, filename: &str) -> String {
        format!("{}-{}", self.app_name, filename)
    }

    /// Save a [`toml::Table`] to browser storage, synchronously.
    ///
    /// # Arguments
    /// * `filename` - the name of the file to be saved
    /// * `contents` - the contents of the file
    pub(crate) fn save(&self, filename: &str, contents: toml::Table) {
        if let Ok(Some(storage)) = window().unwrap().local_storage() {
            let toml_str = contents.to_string();
            storage
                .set_item(self.storage_key(filename).as_str(), &toml_str)
                .unwrap();
        }
    }

    /// Save the content of a [`toml::Table`] to local storage, in another thread.
    ///
    /// # Arguments
    /// * `filename` - the name of the file to be saved
    /// * `contents` - the contents of the file
    pub(crate) fn save_async(&self, filename: &str, contents: toml::Table) {
        IoTaskPool::get().scope(|scope| {
            scope.spawn(async {
                if let Ok(Some(storage)) = window().unwrap().local_storage() {
                    let toml_str = contents.to_string();
                    storage
                        .set_item(self.storage_key(filename).as_str(), &toml_str)
                        .unwrap();
                }
            });
        });
    }

    /// Deserialize a [`toml::Table`]. If the file does not exist, `None` will
    /// be returned.
    ///
    /// # Arguments
    /// * `filename` - The name of the settings file, without the file extension.
    pub(crate) fn load(&self, filename: &str) -> Option<toml::Table> {
        if let Ok(Some(storage)) = window().unwrap().local_storage() {
            let storage_key = self.storage_key(filename);
            let Ok(Some(toml_str)) = storage.get_item(&storage_key) else {
                return None;
            };

            let table_value = match toml::from_str::<toml::Value>(&toml_str) {
                Ok(table_value) => table_value,
                Err(e) => {
                    error!("Error parsing settings file: {}", e);
                    return None;
                }
            };

            match table_value {
                toml::Value::Table(table) => Some(table),
                _ => {
                    error!("Settings file must be a table");
                    None
                }
            }
        } else {
            None
        }
    }
}