human-errors 0.2.4

An error library focused on providing your users with relevant advice for any problem.
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

use std::borrow::Cow;

use super::*;

/// Extension trait for `Option` to convert `None` values into user-friendly
/// error types.
///
/// # Examples
/// ```
/// use human_errors::OptionExt;
///
/// // Converts a `None` value into a user-caused error with the provided message and advice.
/// let value = None::<i32>.ok_or_user_err(
///    "No value was provided.",
///    &["Please provide a valid integer value."],
/// );
///
/// // Converts a `None` value into a system-caused error with the provided message and advice.
/// let value = None::<i32>.ok_or_system_err(
///   "No value was provided.",
///   &["Please check your system configuration."],
/// );
/// ```
pub trait OptionExt<T> {
    /// Converts an `Option<T>` into a `Result<T, Error>`, returning a user-caused
    /// error with the provided message and advice if the option is `None`.
    ///
    /// # Examples
    /// ```
    /// use human_errors::OptionExt;
    ///
    /// let value = None::<i32>.ok_or_user_err(
    ///   "No value was provided.",
    ///   &["Please provide a valid integer value."],
    /// );
    /// ```
    fn ok_or_user_err<S: Into<Cow<'static, str>>>(
        self,
        msg: S,
        advice: &'static [&'static str],
    ) -> Result<T, Error>;

    /// Converts an `Option<T>` into a `Result<T, Error>`, returning a system-caused
    /// error with the provided message and advice if the option is `None`.
    ///
    /// # Examples
    /// ```
    /// use human_errors::OptionExt;
    ///
    /// let value = None::<i32>.ok_or_system_err(
    ///   "No value was provided.",
    ///   &["Please check your system configuration."],
    /// );
    /// ```
    fn ok_or_system_err<S: Into<Cow<'static, str>>>(
        self,
        msg: S,
        advice: &'static [&'static str],
    ) -> Result<T, Error>;
}

impl<T> OptionExt<T> for Option<T> {
    fn ok_or_user_err<S: Into<Cow<'static, str>>>(
        self,
        msg: S,
        advice: &'static [&'static str],
    ) -> Result<T, Error> {
        match self {
            Some(value) => Ok(value),
            None => Err(user(msg.into(), advice)),
        }
    }

    fn ok_or_system_err<S: Into<Cow<'static, str>>>(
        self,
        msg: S,
        advice: &'static [&'static str],
    ) -> Result<T, Error> {
        match self {
            Some(value) => Ok(value),
            None => Err(system(msg.into(), advice)),
        }
    }
}

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

    #[test]
    fn test_ok_or_user_err_some() {
        let value = Some(42)
            .ok_or_user_err("No value", &["Provide a value"])
            .unwrap();
        assert_eq!(value, 42);
    }

    #[test]
    fn test_ok_or_user_err_none() {
        let err = None::<i32>
            .ok_or_user_err("No value", &["Provide a value"])
            .unwrap_err();
        assert!(err.is(Kind::User));
        assert_eq!(err.description(), "No value");
    }

    #[test]
    fn test_ok_or_system_err_some() {
        let value = Some(42)
            .ok_or_system_err("No value", &["Check system"])
            .unwrap();
        assert_eq!(value, 42);
    }

    #[test]
    fn test_ok_or_system_err_none() {
        let err = None::<i32>
            .ok_or_system_err("No value", &["Check system"])
            .unwrap_err();
        assert!(err.is(Kind::System));
        assert_eq!(err.description(), "No value");
    }
}