bevy_pkv 0.16.0

Persistent key value store for apps/games
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use crate::{Location, StoreImpl};
use serde::{de::DeserializeOwned, Serialize};

#[derive(Debug)]
pub struct SledStore {
    db: sled::Db,
}

pub use SledStore as InnerStore;

/// Errors that can occur during `PkvStore::get`
#[derive(thiserror::Error, Debug)]
pub enum GetError {
    /// An internal error from the sled crate
    #[error("Sled error")]
    Sled(#[from] sled::Error),
    /// Error when deserializing the value
    #[error("MessagePack deserialization error")]
    MessagePack(#[from] rmp_serde::decode::Error),
    /// The value for the given key was not found
    #[error("No value found for the given key")]
    NotFound,
}

/// Errors that can occur during `PkvStore::set`
#[derive(thiserror::Error, Debug)]
pub enum SetError {
    /// An internal error from the sled crate
    #[error("Sled error")]
    Sled(#[from] sled::Error),
    /// Error when serializing the value
    #[error("MessagePack serialization error")]
    MessagePack(#[from] rmp_serde::encode::Error),
}

/// Errors that can occur during `PkvStore::remove`
#[derive(thiserror::Error, Debug)]
pub enum RemoveError {
    /// An internal error from the sled crate
    #[error("Sled error")]
    Sled(#[from] sled::Error),
    /// Error when deserializing the value
    #[error("MessagePack deserialization error")]
    MessagePack(#[from] rmp_serde::decode::Error),
    /// The value for the given key was not found
    #[error("No value found for the given key")]
    NotFound,
}

impl SledStore {
    pub(crate) fn new(location: Location) -> Self {
        let db_path = location.get_path().join("bevy_pkv.sled");
        let db = sled::open(db_path).expect("Failed to init key value store");
        Self { db }
    }

    pub(crate) fn new_with_filename(location: Location, filename: &str) -> Self {
        let db_path = location.get_path().join(filename);
        let db = sled::open(db_path).expect("Failed to init key value store");
        Self { db }
    }
}

impl StoreImpl for SledStore {
    type GetError = GetError;
    type SetError = SetError;
    type RemoveError = RemoveError;

    /// Serialize and store the value
    fn set<T: Serialize>(&mut self, key: &str, value: &T) -> Result<(), Self::SetError> {
        let mut serializer = rmp_serde::Serializer::new(Vec::new()).with_struct_map();
        value.serialize(&mut serializer)?;
        self.db.insert(key, serializer.into_inner())?;
        self.db.flush()?;
        Ok(())
    }

    /// More or less the same as set::<String>, but can take a &str
    fn set_string(&mut self, key: &str, value: &str) -> Result<(), Self::SetError> {
        let bytes = rmp_serde::to_vec(value)?;
        self.db.insert(key, bytes)?;
        self.db.flush()?;
        Ok(())
    }

    /// Get the value for the given key
    /// returns Err(GetError::NotFound) if the key does not exist in the key value store.
    fn get<T: DeserializeOwned>(&self, key: &str) -> Result<T, Self::GetError> {
        let bytes = self.db.get(key)?.ok_or(Self::GetError::NotFound)?;
        let value = rmp_serde::from_slice(&bytes)?;
        Ok(value)
    }

    /// Clear all keys and their values
    /// clear is also a kind of store so it will return SetError on failure
    fn clear(&mut self) -> Result<(), Self::SetError> {
        self.db.clear()?;
        self.db.flush()?;
        Ok(())
    }

    fn remove(&mut self, key: &str) -> Result<(), Self::RemoveError> {
        self.db.remove(key)?;
        Ok(())
    }

    fn remove_and_get<T: DeserializeOwned>(
        &mut self,
        key: &str,
    ) -> Result<Option<T>, Self::RemoveError> {
        let bytes = self.db.remove(key)?.ok_or(Self::RemoveError::NotFound)?;
        let value = rmp_serde::from_slice(&bytes)?;
        Ok(value)
    }
}