rivia 0.2.10

Rust utilities to reduce code verbosity
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

use std::{error::Error as StdError, fmt};

/// An error indicating something went wrong with a core Rivia component
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum CoreError
{
    /// A simple error message
    Msg(String),

    /// Error return panic capture output
    PanicCapture(String),

    /// Error indicating a panic capture failed
    PanicCaptureFailure,
}

impl CoreError
{
    /// Return a simple error with the given message
    pub fn msg<T: AsRef<str>>(msg: T) -> CoreError
    {
        CoreError::Msg(msg.as_ref().to_owned())
    }

    /// Return a simple error with the given message
    pub fn panic_capture<T: AsRef<str>>(msg: T) -> CoreError
    {
        CoreError::PanicCapture(msg.as_ref().to_owned())
    }
}

impl StdError for CoreError {}

impl fmt::Display for CoreError
{
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result
    {
        match *self {
            CoreError::Msg(ref msg) => write!(f, "{}", msg),
            CoreError::PanicCapture(ref msg) => write!(f, "{}", msg),
            CoreError::PanicCaptureFailure => write!(f, "an error occured during a panic capture"),
        }
    }
}

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

    #[test]
    fn test_errors()
    {
        assert_eq!(CoreError::msg("foo").to_string(), "foo");
        assert_eq!(CoreError::Msg("foo".to_string()).to_string(), "foo");
        assert_eq!(CoreError::PanicCapture("foo".to_string()).to_string(), "foo");
        assert_eq!(CoreError::PanicCaptureFailure.to_string(), "an error occured during a panic capture");
    }
}