exar 0.1.0

Exar DB's core event store engine with streaming support
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

use super::*;

use std::fmt::{Display, Formatter, Result as DisplayResult};
use std::io::{Error as IoError, ErrorKind};

/// A list specifying categories of database error.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum DatabaseError {
    /// The credentials used to connect to the database are either missing or invalid.
    AuthenticationError,
    /// The connection to the database failed.
    ConnectionError,
    /// The event stream has been closed unexpectedly.
    EventStreamError(EventStreamError),
    /// An I/O error occurred.
    IoError(ErrorKind, String),
    /// The parsing of an event from the log file failed.
    ParseError(ParseError),
    /// The attempted subscription failed.
    SubscriptionError,
    /// The validation of the event failed.
    ValidationError(ValidationError)
}

impl DatabaseError {
    /// Returns a `DatabaseError` from the given `std::io::Error`.
    pub fn from_io_error(err: IoError) -> DatabaseError {
        DatabaseError::IoError(err.kind(), format!("{}", err))
    }
}

impl ToTabSeparatedString for DatabaseError {
    fn to_tab_separated_string(&self) -> String {
        match *self {
            DatabaseError::AuthenticationError => tab_separated!("AuthenticationError"),
            DatabaseError::ConnectionError => tab_separated!("ConnectionError"),
            DatabaseError::EventStreamError(ref error) => {
                tab_separated!("EventStreamError", match *error {
                    EventStreamError::Empty => "Empty",
                    EventStreamError::Closed => "Closed"
                })
            },
            DatabaseError::IoError(ref error_kind, ref description) => {
                tab_separated!("IoError", error_kind.to_tab_separated_string(), description)
            },
            DatabaseError::ParseError(ref error) => match error {
                &ParseError::ParseError(ref description) => tab_separated!("ParseError", "ParseError", description),
                &ParseError::MissingField(index) => tab_separated!("ParseError", "MissingField", index)
            },
            DatabaseError::SubscriptionError => tab_separated!("SubscriptionError"),
            DatabaseError::ValidationError(ref error) => tab_separated!("ValidationError", error.description)
        }
    }
}

impl FromTabSeparatedStr for DatabaseError {
    fn from_tab_separated_str(s: &str) -> Result<DatabaseError, ParseError> {
        let mut parser = TabSeparatedParser::new(2, s);
        let message_type: String = try!(parser.parse_next());
        match &message_type[..] {
            "AuthenticationError" => Ok(DatabaseError::AuthenticationError),
            "ConnectionError" => Ok(DatabaseError::ConnectionError),
            "EventStreamError" => {
                let error: String = try!(parser.parse_next());
                match &error[..] {
                    "Empty" => Ok(DatabaseError::EventStreamError(EventStreamError::Empty)),
                    "Closed" => Ok(DatabaseError::EventStreamError(EventStreamError::Closed)),
                    x => Err(ParseError::ParseError(format!("unknown event stream error: {}", x)))
                }
            },
            "IoError" => {
                let message_data: String = try!(parser.parse_next());
                let mut parser = TabSeparatedParser::new(2, &message_data);
                let error_kind: String = try!(parser.parse_next());
                let error_kind = try!(ErrorKind::from_tab_separated_str(&error_kind));
                let error_description: String = try!(parser.parse_next());
                Ok(DatabaseError::IoError(error_kind, error_description))
            },
            "ParseError" => {
                let message_data: String = try!(parser.parse_next());
                let mut parser = TabSeparatedParser::new(2, &message_data);
                let error_type: String = try!(parser.parse_next());
                match &error_type[..] {
                    "ParseError" => {
                        let error = ParseError::ParseError(try!(parser.parse_next()));
                        Ok(DatabaseError::ParseError(error))
                    },
                    "MissingField" => {
                        let error = ParseError::MissingField(try!(parser.parse_next()));
                        Ok(DatabaseError::ParseError(error))
                    },
                    x => Err(ParseError::ParseError(format!("unknown parse error: {}", x)))
                }
            },
            "SubscriptionError" => Ok(DatabaseError::SubscriptionError),
            "ValidationError" => {
                let description: String = try!(parser.parse_next());
                Ok(DatabaseError::ValidationError(ValidationError::new(&description)))
            },
            x => Err(ParseError::ParseError(format!("unknown database error: {}", x)))
        }
    }
}

impl ToTabSeparatedString for ErrorKind {
    fn to_tab_separated_string(&self) -> String {
        match *self {
            ErrorKind::NotFound => "NotFound",
            ErrorKind::PermissionDenied => "PermissionDenied",
            ErrorKind::ConnectionRefused => "ConnectionRefused",
            ErrorKind::ConnectionReset => "ConnectionReset",
            ErrorKind::ConnectionAborted => "ConnectionAborted",
            ErrorKind::NotConnected => "NotConnected",
            ErrorKind::AddrInUse => "AddrInUse",
            ErrorKind::AddrNotAvailable => "AddrNotAvailable",
            ErrorKind::BrokenPipe => "BrokenPipe",
            ErrorKind::AlreadyExists => "AlreadyExists",
            ErrorKind::WouldBlock => "WouldBlock",
            ErrorKind::InvalidInput => "InvalidInput",
            ErrorKind::InvalidData => "InvalidData",
            ErrorKind::TimedOut => "TimedOut",
            ErrorKind::WriteZero => "WriteZero",
            ErrorKind::Interrupted => "Interrupted",
            ErrorKind::Other => "Other",
            ErrorKind::UnexpectedEof => "UnexpectedEof",
            _ => "Unknown"
        }.to_owned()
    }
}

impl FromTabSeparatedStr for ErrorKind {
    fn from_tab_separated_str(s: &str) -> Result<ErrorKind, ParseError> {
        match &s[..] {
            "NotFound" => Ok(ErrorKind::NotFound),
            "PermissionDenied" => Ok(ErrorKind::PermissionDenied),
            "ConnectionRefused" => Ok(ErrorKind::ConnectionRefused),
            "ConnectionReset" => Ok(ErrorKind::ConnectionReset),
            "ConnectionAborted" => Ok(ErrorKind::ConnectionAborted),
            "NotConnected" => Ok(ErrorKind::NotConnected),
            "AddrInUse" => Ok(ErrorKind::AddrInUse),
            "AddrNotAvailable" => Ok(ErrorKind::AddrNotAvailable),
            "BrokenPipe" => Ok(ErrorKind::BrokenPipe),
            "AlreadyExists" => Ok(ErrorKind::AlreadyExists),
            "WouldBlock" => Ok(ErrorKind::WouldBlock),
            "InvalidInput" => Ok(ErrorKind::InvalidInput),
            "InvalidData" => Ok(ErrorKind::InvalidData),
            "TimedOut" => Ok(ErrorKind::TimedOut),
            "WriteZero" => Ok(ErrorKind::WriteZero),
            "Interrupted" => Ok(ErrorKind::Interrupted),
            "Other" => Ok(ErrorKind::Other),
            "UnexpectedEof" => Ok(ErrorKind::UnexpectedEof),
            x => Err(ParseError::ParseError(format!("unknown error kind: {}", x)))
        }
    }
}

impl Display for DatabaseError {
    fn fmt(&self, f: &mut Formatter) -> DisplayResult {
        match *self {
            DatabaseError::AuthenticationError => write!(f, "authentication failure"),
            DatabaseError::ConnectionError => write!(f, "connection failure"),
            DatabaseError::EventStreamError(EventStreamError::Closed) => write!(f, "event stream is closed"),
            DatabaseError::EventStreamError(EventStreamError::Empty) => write!(f, "event stream is empty"),
            DatabaseError::IoError(_, ref error) => write!(f, "{}", error),
            DatabaseError::ParseError(ref error) => write!(f, "{}", error),
            DatabaseError::SubscriptionError => write!(f, "subscription failure"),
            DatabaseError::ValidationError(ref error) => write!(f, "{}", error)
        }
    }
}

#[cfg(test)]
mod tests {
    use super::super::*;

    use std::io::ErrorKind;

    #[test]
    fn test_database_error_tab_separator_encoding() {
        let authentication_error = DatabaseError::AuthenticationError;
        let connection_error = DatabaseError::ConnectionError;
        let event_stream_closed = DatabaseError::EventStreamError(EventStreamError::Closed);
        let event_stream_empty = DatabaseError::EventStreamError(EventStreamError::Empty);
        let io_error = DatabaseError::IoError(ErrorKind::Other, "error".to_owned());
        let parse_error = DatabaseError::ParseError(ParseError::ParseError("error".to_owned()));
        let missig_field = DatabaseError::ParseError(ParseError::MissingField(1));
        let subscription_error = DatabaseError::SubscriptionError;
        let validation_error = DatabaseError::ValidationError(ValidationError { description: "error".to_owned() });

        assert_encoded_eq!(authentication_error, "AuthenticationError");
        assert_encoded_eq!(connection_error, "ConnectionError");
        assert_encoded_eq!(event_stream_closed, "EventStreamError\tClosed");
        assert_encoded_eq!(event_stream_empty, "EventStreamError\tEmpty");
        assert_encoded_eq!(io_error, "IoError\tOther\terror");
        assert_encoded_eq!(parse_error, "ParseError\tParseError\terror");
        assert_encoded_eq!(missig_field, "ParseError\tMissingField\t1");
        assert_encoded_eq!(subscription_error, "SubscriptionError");
        assert_encoded_eq!(validation_error, "ValidationError\terror");
    }

    #[test]
    fn test_database_error_tab_separator_decoding() {
        let authentication_error = DatabaseError::AuthenticationError;
        let connection_error = DatabaseError::ConnectionError;
        let event_stream_closed = DatabaseError::EventStreamError(EventStreamError::Closed);
        let event_stream_empty = DatabaseError::EventStreamError(EventStreamError::Empty);
        let io_error = DatabaseError::IoError(ErrorKind::Other, "error".to_owned());
        let parse_error = DatabaseError::ParseError(ParseError::ParseError("error".to_owned()));
        let missig_field = DatabaseError::ParseError(ParseError::MissingField(1));
        let subscription_error = DatabaseError::SubscriptionError;
        let validation_error = DatabaseError::ValidationError(ValidationError { description: "error".to_owned() });

        assert_decoded_eq!("AuthenticationError", authentication_error);
        assert_decoded_eq!("ConnectionError", connection_error);
        assert_decoded_eq!("EventStreamError\tClosed", event_stream_closed);
        assert_decoded_eq!("EventStreamError\tEmpty", event_stream_empty);
        assert_decoded_eq!("IoError\tOther\terror", io_error);
        assert_decoded_eq!("ParseError\tParseError\terror", parse_error);
        assert_decoded_eq!("ParseError\tMissingField\t1", missig_field);
        assert_decoded_eq!("SubscriptionError", subscription_error);
        assert_decoded_eq!("ValidationError\terror", validation_error);
    }
}