summaryrefslogtreecommitdiffstats
path: root/src/errors.rs
blob: 637b7d23bc347ca6b7fcbdc4bd79b944ac94ed7d (plain)
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
//! Basic error handling mechanisms

use std::error::Error;
use std::fmt;

/// The result type for `GitJournal`
pub type GitJournalResult<T> = Result<T, Box<Error>>;

/// Concrete errors
struct GitJournalError {
    description: String,
    detail: Option<String>,
    cause: Option<Box<Error + Send>>,
}

impl fmt::Display for GitJournalError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.description)?;
        if let Some(ref s) = self.detail {
            write!(f, ": {}", s)?;
        }
        Ok(())
    }
}

impl fmt::Debug for GitJournalError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt(self, f)
    }
}

impl Error for GitJournalError {
    fn description(&self) -> &str {
        &self.description
    }

    #[cfg_attr(feature = "cargo-clippy", allow(let_and_return))]
    fn cause(&self) -> Option<&Error> {
        self.cause.as_ref().map(|c| {
            let e: &Error = &**c;
            e
        })
    }
}

/// Raise an internal error
pub fn error(error: &str, detail: &str) -> Box<Error> {
    Box::new(GitJournalError {
        description: error.to_string(),
        detail: Some(detail.to_string()),
        cause: None,
    })
}

pub fn bail(error: &fmt::Display) -> Box<Error> {
    Box::new(GitJournalError {
        description: error.to_string(),
        detail: None,
        cause: None,
    })
}

macro_rules! bail {
    ($($fmt:tt)*) => (
        return Err(::errors::bail(&format_args!($($fmt)*)))
    )
}