koit 0.2.0

A simple, asynchronous, pure-Rust, structured, embedded database
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

//! Formats handle transforming structured data to and from bytes for persisting.

/// Trait implementable by format providers.
///
/// By implementing this trait, a type becomes a marker for the specified format.
/// That type can then be used for formatting (without instantiating an object of that type).
pub trait Format<T>: Sized {
    type Error: std::error::Error + Send + Sync + 'static;

    /// Convert data to bytes.
    ///
    /// # Errors
    ///
    /// If the data failed to be encoded by the format, an error variant is returned.
    fn to_bytes(value: &T) -> Result<Vec<u8>, Self::Error>;

    /// Convert bytes to data.
    ///
    /// # Errors
    ///
    /// If the bytes failed to be decoded by the format, an error variant is returned.
    fn from_bytes(data: Vec<u8>) -> Result<T, Self::Error>;
}

#[cfg(feature = "json-format")]
pub use self::json::Json;

#[cfg(feature = "bincode-format")]
pub use self::bincode::Bincode;


#[cfg(feature = "json-format")]
mod json {
    use serde::{de::DeserializeOwned, Serialize};

    use super::Format;

    #[cfg_attr(docsrs, doc(cfg(feature = "json-format")))]
    /// A pretty-printed JSON [`Format`](crate::format::Format).
    #[derive(Debug, std::default::Default)]
    pub struct Json;

    impl<T: DeserializeOwned + Serialize> Format<T> for Json {
        type Error = serde_json::Error;

        fn to_bytes(value: &T) -> Result<Vec<u8>, Self::Error> {
            Ok(serde_json::to_vec_pretty(value)?)
        }
        fn from_bytes(data: Vec<u8>) -> Result<T, serde_json::Error> {
            Ok(serde_json::from_slice(&data)?)
        }
    }
}

#[cfg(feature = "bincode-format")]
mod bincode {
    use serde::{de::DeserializeOwned, Serialize};

    use super::Format;

    #[cfg_attr(docsrs, doc(cfg(feature = "bincode-format")))]
    /// A Bincode [`Format`](crate::format::Format).
    #[derive(Debug, std::default::Default)]
    pub struct Bincode;

    impl<T: Serialize + DeserializeOwned> Format<T> for Bincode {
        type Error = bincode::Error;

        fn to_bytes(value: &T) -> Result<Vec<u8>, Self::Error> {
            Ok(bincode::serialize(value)?)
        }
        fn from_bytes(data: Vec<u8>) -> Result<T, Self::Error> {
            Ok(bincode::deserialize(&data)?)
        }
    }
}