reindeer 0.1.3

A small entity-based embedded database with a minimal no-SQL relationnal model, written in pure Rust.
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

use std::{fmt};


/// Error kind enum for Reindeer-related errors.
#[non_exhaustive]
#[derive(Debug,Clone,Copy)]
pub enum ErrorKind {
    /// Something went wrong at the `sled` level.
    SledError,
    /// Could not serialize or deserialize an entity
    SerializationError,
    /// Any kind of file system error while using the database
    IOError,
    /// An integrity constraint has been violated while trying to remove an entity from the database
    IntegrityError,
    /// An entity was not found
    NotFound,
    /// An entity was used without being registered firts in the database
    UnregisteredEntity,
}

/// Error type for `reindeer`
#[derive(Debug)]
pub struct Error {
    error_kind : ErrorKind,
    message : String,
}

impl Error {
    /// Creates a new error from an error kind and a message
    pub fn new(error_kind : ErrorKind,message : String) -> Error {
        Error {
            error_kind,
            message : message,
        }
    }
    pub fn kind(&self) -> ErrorKind {
        self.error_kind
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Reindeer Error of type {:?} : {}",self.error_kind,&self.message)
    }
}

impl std::error::Error for Error {}

/// Type definition to simplify the use of Result everywhere in the library
pub type Result<T> = std::result::Result<T, Error>;

impl From<std::io::Error> for Error {
    fn from(source: std::io::Error) -> Self {
        Error::new(
            ErrorKind::IOError,
            source.to_string(),
        )
    }
}

impl From<sled::Error> for Error {
    fn from(source: sled::Error) -> Self {
        Error::new(
            ErrorKind::SledError,
            source.to_string(),
        )
    }
}

impl From<bincode::Error> for Error {
    fn from(source: bincode::Error) -> Self {
        Error::new(
            ErrorKind::SerializationError,
            source.to_string(),
        )
    }
}

impl From<serde_json::Error> for Error {
    fn from(source: serde_json::Error) -> Self {
        Error::new(
            ErrorKind::SerializationError,
            source.to_string(),
        )
    }
}