amethystate-core 0.25.0

Internal crate for amethystate, not intended for direct use
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

use crate::failure::StorageResult;
use crate::path::StorePath;
#[cfg(feature = "async")]
use error_stack::Report;
use serde::Serialize;
use serde::de::DeserializeOwned;
use std::borrow::Borrow;
use uuid::Uuid;

/// A store that answers on the calling thread.
///
/// It fails with [`StorageError`](crate::failure::StorageError) rather than an error of its own: what an
/// engine said is the frame below, and telling a depth refusal from a codec
/// one at the point a caller has to act on it needs the kind to survive the
/// trip. An associated type would put it behind a bound nobody could name.
pub trait AmeBackendSync {
    type Raw: Borrow<Self::Borrowed>;
    type Borrowed: ?Sized;

    fn get<T>(&self, path: &StorePath) -> StorageResult<Option<T>>
    where
        T: DeserializeOwned;

    fn set_owned<T: Serialize>(&self, path: StorePath, value: &T) -> StorageResult<()> {
        self.set(&path, value)
    }

    fn set_with_source<T: Serialize>(
        &self,
        path: &StorePath,
        value: &T,
        source: Option<Uuid>,
    ) -> StorageResult<()>;
    fn set_owned_with_source<T: Serialize>(
        &self,
        path: StorePath,
        value: &T,
        source: Option<Uuid>,
    ) -> StorageResult<()>;

    fn set<T>(&self, path: &StorePath, value: &T) -> StorageResult<()>
    where
        T: Serialize;

    fn delete(&self, path: &StorePath) -> StorageResult<()>;

    fn delete_with_source(&self, path: &StorePath, source: Option<Uuid>) -> StorageResult<()>;

    /// Removes every key under `prefix` as one operation, emitting a single
    /// event rather than one per key.
    fn delete_prefix(&self, prefix: &StorePath, source: Option<Uuid>) -> StorageResult<()>;

    fn scan_prefix(&self, prefix: &StorePath) -> StorageResult<Vec<(StorePath, Self::Raw)>>;

    /// The keys under `prefix`, sorted, without reading their values.
    fn scan_keys(&self, prefix: &StorePath) -> StorageResult<Vec<StorePath>>;

    fn decode<T>(&self, raw: &Self::Borrowed) -> StorageResult<T>
    where
        T: DeserializeOwned + Default;
}
#[cfg(feature = "async")]
#[allow(async_fn_in_trait)]
pub trait AmeBackendAsync {
    type Error: std::error::Error + Send + Sync + 'static;
    type Raw;

    async fn get<T>(&self, path: &StorePath) -> Result<Option<T>, Report<Self::Error>>
    where
        T: DeserializeOwned;

    async fn set<T>(&self, path: &StorePath, value: &T) -> Result<(), Report<Self::Error>>
    where
        T: Serialize;
    async fn set_with_source<T: Serialize>(
        &self,
        path: &StorePath,
        value: &T,
        source: Option<Uuid>,
    ) -> Result<(), Report<Self::Error>>;
    async fn set_owned_with_source<T: Serialize>(
        &self,
        path: StorePath,
        value: &T,
        source: Option<Uuid>,
    ) -> Result<(), Report<Self::Error>>;

    async fn delete(&self, path: &StorePath) -> Result<(), Report<Self::Error>>;
    async fn delete_with_source(
        &self,
        path: &StorePath,
        source: Option<Uuid>,
    ) -> Result<(), Report<Self::Error>>;

    /// Removes the whole subtree as one operation, so subscribers hear one
    /// change at the prefix rather than one per key.
    async fn delete_prefix(
        &self,
        prefix: &StorePath,
        source: Option<Uuid>,
    ) -> Result<(), Report<Self::Error>>;

    async fn scan_prefix(
        &self,
        prefix: &StorePath,
    ) -> Result<Vec<(StorePath, Self::Raw)>, Report<Self::Error>>;

    async fn scan_keys(&self, prefix: &StorePath) -> Result<Vec<StorePath>, Report<Self::Error>>;

    fn decode<T>(&self, raw: &Self::Raw) -> Result<T, Report<Self::Error>>
    where
        T: DeserializeOwned + Default;
}