bevy_simple_preferences 0.1.0

A simple Preferences API for Bevy
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

//! Contains everything related to store and load preferences.
//! Two main submodules are present, depending on the platform.
//!
//! For native, the submodule `fs` is present, and allows load and storing from disk.
//! For web, the submodule `gloo` is present, and allows load and storing from local and session storage.
#[cfg(not(target_family = "wasm"))]
pub mod fs;

#[cfg(target_family = "wasm")]
pub(crate) mod gloo;

use crate::serializable_map::{PreferencesSerializableMap, PreferencesSerializableMapSeed};
use crate::Result;
use bevy::prelude::*;
use std::ops::Deref;
use std::sync::Arc;

/// Trait used to represent how preferences are loaded and saved.
/// Final applications can have custom storages by implementing this trait.
pub trait PreferencesStorage: Send + Sync + 'static {
    /// Loads the preferences using the [`PreferencesSerializableMapSeed`] passed as a value.
    fn load_preferences(
        &self,
        deserialize_seed: PreferencesSerializableMapSeed,
    ) -> Result<PreferencesSerializableMap>;

    /// Saves the preferences
    fn save_preferences(&self, map: &PreferencesSerializableMap) -> Result<()>;
}

/// Represents the current Preferences storage used.
/// If no storage is used, this Resources will not be present at all.
#[derive(Resource)]
pub struct PreferencesStorageResource(Arc<dyn PreferencesStorage>);

impl PreferencesStorageResource {
    pub(crate) fn new(storage: impl PreferencesStorage) -> Self {
        Self(Arc::new(storage))
    }

    pub(crate) fn from_arc(storage: Arc<dyn PreferencesStorage>) -> Self {
        Self(storage)
    }
}

impl Deref for PreferencesStorageResource {
    type Target = dyn PreferencesStorage;

    fn deref(&self) -> &Self::Target {
        &*self.0
    }
}