Skip to main content

dotenv/
errors.rs

1use std::io;
2use std::fmt;
3use std::error;
4
5pub type Result<T> = std::result::Result<T, Error>;
6
7#[derive(Debug)]
8pub enum Error {
9    LineParse(String, usize),
10    Io(io::Error),
11    EnvVar(std::env::VarError),
12    #[doc(hidden)]
13    __Nonexhaustive
14}
15
16impl Error {
17    pub fn not_found(&self) -> bool {
18        if let Error::Io(ref io_error) = *self {
19            return io_error.kind() == io::ErrorKind::NotFound;
20        }
21        false
22    }
23}
24
25impl error::Error for Error {
26    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
27        match self {
28            Error::Io(err) => Some(err),
29            Error::EnvVar(err) => Some(err),
30            _ => None,
31        }
32    }
33}
34
35impl fmt::Display for Error {
36    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
37        match self {
38            Error::Io(err) => write!(fmt, "{}", err),
39            Error::EnvVar(err) => write!(fmt, "{}", err),
40            Error::LineParse(line, error_index) => write!(fmt, "Error parsing line: '{}', error at line index: {}", line, error_index),
41            _ => unreachable!(),
42        }
43    }
44}
45
46#[cfg(test)]
47mod test {
48    use std::error::Error as StdError;
49
50    use super::*;
51
52    #[test]
53    fn test_io_error_source() {
54        let err = Error::Io(std::io::ErrorKind::PermissionDenied.into());
55        let io_err = err.source().unwrap().downcast_ref::<std::io::Error>().unwrap();
56        assert_eq!(std::io::ErrorKind::PermissionDenied, io_err.kind());
57    }
58
59    #[test]
60    fn test_envvar_error_source() {
61        let err = Error::EnvVar(std::env::VarError::NotPresent);
62        let var_err = err.source().unwrap().downcast_ref::<std::env::VarError>().unwrap();
63        assert_eq!(&std::env::VarError::NotPresent, var_err);
64    }
65
66    #[test]
67    fn test_lineparse_error_source() {
68        let err = Error::LineParse("test line".to_string(), 2);
69        assert!(err.source().is_none());
70    }
71
72    #[test]
73    fn test_error_not_found_true() {
74        let err = Error::Io(std::io::ErrorKind::NotFound.into());
75        assert!(err.not_found());
76    }
77
78    #[test]
79    fn test_error_not_found_false() {
80        let err = Error::Io(std::io::ErrorKind::PermissionDenied.into());
81        assert!(!err.not_found());
82    }
83
84    #[test]
85    fn test_io_error_display() {
86        let err = Error::Io(std::io::ErrorKind::PermissionDenied.into());
87        let io_err: std::io::Error = std::io::ErrorKind::PermissionDenied.into();
88
89        let err_desc = format!("{}", err);
90        let io_err_desc = format!("{}", io_err);
91        assert_eq!(io_err_desc, err_desc);
92    }
93
94    #[test]
95    fn test_envvar_error_display() {
96        let err = Error::EnvVar(std::env::VarError::NotPresent);
97        let var_err = std::env::VarError::NotPresent;
98
99        let err_desc = format!("{}", err);
100        let var_err_desc = format!("{}", var_err);
101        assert_eq!(var_err_desc, err_desc);
102    }
103
104    #[test]
105    fn test_lineparse_error_display() {
106        let err = Error::LineParse("test line".to_string(), 2);
107        let err_desc = format!("{}", err);
108        assert_eq!("Error parsing line: 'test line', error at line index: 2", err_desc);
109    }
110}