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

use std::{
    error::Error,
    fmt::{self, Debug, Display, Formatter},
};

/// This will be thrown at you if the somehting within Exmex went wrong. Ok, obviously it is not an
/// exception, so thrown needs to be understood figuratively.
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Debug)]
pub struct RvError {
    msg: String,
}
impl RvError {
    pub fn new(msg: &str) -> RvError {
        RvError {
            msg: msg.to_string(),
        }
    }
    pub fn msg(&self) -> &str {
        &self.msg
    }
}
impl Display for RvError {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        write!(f, "{}", self.msg)
    }
}
impl Error for RvError {}

/// RV Image's result type with [`RvError`](RvError) as error type.
pub type RvResult<U> = Result<U, RvError>;

/// Creates an [`RvError`](RvError) with a formatted message.
/// ```rust
/// # use std::error::Error;
/// use rvlib::{rverr, {result::RvError}};
/// # fn main() -> Result<(), Box<dyn Error>> {
/// assert_eq!(rverr!("some error {}", 1), RvError::new(format!("some error {}", 1).as_str()));
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! rverr {
    ($s:literal, $( $exps:expr ),*) => {
        $crate::result::RvError::new(format!($s, $($exps,)*).as_str())
    }
}

pub fn to_rv<E: Debug>(e: E) -> RvError {
    rverr!(
        "original error type is '{:?}', error message is '{:?}'",
        std::any::type_name::<E>(),
        e
    )
}