microkv 0.3.0

secure minimal key-value store
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

use thiserror::Error;

/// Result with the crate's [`enum@Error`].
pub type Result<T> = std::result::Result<T, Error>;

/// Anything that can go wrong. Non-exhaustive; match with a wildcard arm.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum Error {
    #[error("key not found")]
    KeyNotFound,

    #[error("incorrect password or key")]
    WrongPassword,

    #[error("corrupt store: {0}")]
    CorruptStore(String),

    #[error("unsupported store version {found} (expected {expected})")]
    UnsupportedStoreVersion { found: u8, expected: u8 },

    #[error("cryptographic operation failed")]
    Crypto,

    #[error("could not read OS randomness")]
    Random,

    /// `mlock`-ed allocation failed and the `strict-mlock` feature is on.
    #[error("secure memory allocation failed")]
    SecureAlloc,

    #[error("serialization error: {0}")]
    Serialization(String),

    #[error("io error: {0}")]
    Io(#[from] std::io::Error),

    /// Poisoned in-process lock or a contended cross-process file lock.
    #[error("lock unavailable or poisoned")]
    Locked,

    #[error("store already exists")]
    AlreadyExists,

    #[error("store is read-only")]
    ReadOnly,

    #[error("entry expired")]
    Expired,

    /// Persistence attempted on an in-memory store.
    #[error("no path associated with store")]
    NoPath,
}