dodo 0.3.1

Basic persistence library designed to be a quick and easy way to create a persistent storage.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use std::{fmt, result};
use std::error::Error;

use crate::serializer::{SerializerError, SerializerErrorKind};
use crate::storage::{StorageError, StorageErrorKind};

/// Index error.
#[derive(Debug)]
pub struct IndexError(Box<RawIndexError>);

#[derive(Debug)]
struct RawIndexError {
    kind: IndexErrorKind,
    source: Option<Box<dyn std::error::Error + Send + Sync>>,
}

impl IndexError {
    pub(crate) fn not_found() -> Self {
        Self(Box::new(RawIndexError {
            kind: IndexErrorKind::NotFound,
            source: None,
        }))
    }

    pub(crate) fn syntax<E>(error: E) -> Self
        where E: Into<Box<dyn std::error::Error + Send + Sync>> {
        Self(Box::new(RawIndexError {
            kind: IndexErrorKind::Syntax,
            source: Some(error.into()),
        }))
    }

    pub(crate) fn storage_corrupted<E>(error: E) -> Self
        where E: Into<Box<dyn std::error::Error + Send + Sync>> {
        Self(Box::new(RawIndexError {
            kind: IndexErrorKind::StorageCorrupted,
            source: Some(error.into()),
        }))
    }

    pub(crate) fn io<E>(error: E) -> Self
        where E: Into<Box<dyn std::error::Error + Send + Sync>> {
        Self(Box::new(RawIndexError {
            kind: IndexErrorKind::Io,
            source: Some(error.into()),
        }))
    }

    pub(crate) fn other<E>(error: E) -> Self
        where E: Into<Box<dyn std::error::Error + Send + Sync>> {
        Self(Box::new(RawIndexError {
            kind: IndexErrorKind::Other,
            source: Some(error.into()),
        }))
    }

    /// Error kind.
    pub fn kind(&self) -> IndexErrorKind {
        self.0.kind
    }

    /// Returns true if this error is NotFound.
    pub fn is_not_found(&self) -> bool {
        IndexErrorKind::NotFound == self.0.kind
    }

    /// Returns true if this error a Syntax.
    pub fn is_syntax(&self) -> bool {
        IndexErrorKind::Syntax == self.0.kind
    }

    /// Returns true if this error a StorageCorrupted.
    pub fn is_storage_corrupted(&self) -> bool {
        IndexErrorKind::StorageCorrupted == self.0.kind
    }

    /// Returns true if this error Io.
    pub fn is_io(&self) -> bool {
        IndexErrorKind::Io == self.0.kind
    }

    /// Returns true if this error is Other.
    pub fn is_other(&self) -> bool {
        IndexErrorKind::Other == self.0.kind
    }
}

impl Error for IndexError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self.0.source {
            Some(ref source) => Some(&**source),
            None => None
        }
    }
}

impl fmt::Display for IndexError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.kind.fmt(f)
    }
}

impl From<StorageError> for IndexError {
    fn from(error: StorageError) -> Self {
        use StorageErrorKind::*;

        match error.kind() {
            InvalidUuid => Self::storage_corrupted(error),
            Io => Self::io(error),
            Other => Self::other(error),
            NotFound => panic!("index file not found"),
        }
    }
}

impl From<SerializerError> for IndexError {
    fn from(error: SerializerError) -> Self {
        use SerializerErrorKind::*;

        match error.kind() {
            Syntax => Self::syntax(error),
            Io => Self::io(error),
            Other => Self::other(error)
        }
    }
}

/// Index error kind.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum IndexErrorKind {
    /// Value not found in index.
    NotFound,
    /// Serialization/deserialization error.
    Syntax,
    /// Storage is in an invalid state and cannot perform the requested operation.
    StorageCorrupted,
    /// Io error (unexpected EOF, interrupted, ...).
    Io,
    /// Other error.
    Other,
}

impl fmt::Display for IndexErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        use IndexErrorKind::*;

        match self {
            NotFound => write!(f, "value not found"),
            Syntax => write!(f, "serialization/deserialization error"),
            StorageCorrupted => write!(f, "storage is corrupted"),
            Io => write!(f, "io error"),
            Other => write!(f, "other error"),
        }
    }
}

/// Index result.
pub type Result<T> = result::Result<T, IndexError>;