rustberry 0.1.0

All-purpose Raspberry Pi library for 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

// Copyright (C) 2018  Adam Gausmann
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

//! Common error types used by the crate.

use std::error::Error as ErrorBase;
use std::fmt;
use std::io;

/// Types of errors returned by this crate.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ErrorKind {

    /// The item requested has already been reserved.
    Reserved,

    /// The identifier given is invalid for this item type.
    OutOfRange,

    /// A critical I/O error occurred during this function call.
    IoError,

    /// The detected system is not supported by this crate.
    UnsupportedSystem,
}

impl fmt::Display for ErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            ErrorKind::Reserved => f.write_str(
                "That item has already been reserved."
            ),
            ErrorKind::OutOfRange => f.write_str(
                "That identifier is out of range."
            ),
            ErrorKind::IoError => f.write_str(
                "An I/O error has occurred."
            ),
            ErrorKind::UnsupportedSystem => f.write_str(
                "The detected system is not supported by this crate."
            ),
        }
    }
}

/// Common error type returned by this crate.
#[derive(Debug)]
pub struct Error {
    kind: ErrorKind,
    cause: Option<Box<ErrorBase>>,
}

impl Error {
    pub(crate) fn new(kind: ErrorKind) -> Error {
        Error {
            kind,
            cause: None,
        }
    }

    pub(crate) fn with_cause<E>(kind: ErrorKind, cause: E) -> Error
    where
        E: ErrorBase + 'static,
    {
        Error {
            kind,
            cause: Some(Box::new(cause) as Box<ErrorBase>),
        }
    }

}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        <ErrorKind as fmt::Display>::fmt(&self.kind, f)
    }
}

impl ErrorBase for Error {
    fn cause(&self) -> Option<&ErrorBase> {
        self.cause.as_ref()
            .map(Box::as_ref)
    }
}

impl From<io::Error> for Error {
    fn from(e: io::Error) -> Error {
        Error::with_cause(ErrorKind::IoError, e)
    }
}