errcode 0.1.0-alpha.2

A Rust library for simplified error handling.
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use errcode::{ErrorCode, error_info, error, bail, ensure, prelude::*};

#[derive(ErrorCode, Debug, PartialEq, Eq, Clone, Copy)]
pub enum TestCode {
    A,
    B,
}

#[test]
fn test_error_info_no_args() {
    let info = error_info!();
    // Default is "error encountered"
    // We can't easily check ErrorInfo directly as its fields are private or opaque
    // but we can check the resulting Error's string representation.
    let err: errcode::Error = errcode::Error::from_info(info);
    assert!(err.to_string().contains("error encountered"));
}

#[test]
fn test_error_info_format_literal() {
    let info = error_info!("test message");
    let err = errcode::Error::from_info(info);
    assert!(err.to_string().contains("test message"));
}

#[test]
fn test_error_info_format_args() {
    let info = error_info!("test message: {}", 42);
    let err = errcode::Error::from_info(info);
    
    #[cfg(feature = "repr_full")]
    {
        assert!(err.to_string().contains("test message: 42"));
    }
    #[cfg(not(feature = "repr_full"))]
    {
        assert!(err.to_string().contains("test message: {}"));
    }
}

#[test]
fn test_error_info_code_only() {
    let info = error_info!(TestCode::A);
    let err = errcode::Error::from_info(info);
    assert!(err.is(TestCode::A));
}

#[test]
fn test_error_info_code_and_format() {
    let info = error_info!(TestCode::B, "with message");
    let err = errcode::Error::from_info(info);
    assert!(err.is(TestCode::B));
    assert!(err.to_string().contains("with message"));
}

#[test]
fn test_error_info_code_and_format_args() {
    let info = error_info!(TestCode::A, "with message: {}", "val");
    let err = errcode::Error::from_info(info);
    assert!(err.is(TestCode::A));
    #[cfg(feature = "repr_full")]
    {
        assert!(err.to_string().contains("with message: val"));
    }
    #[cfg(not(feature = "repr_full"))]
    {
        assert!(err.to_string().contains("with message: {}"));
    }
}

#[test]
fn test_error_macro() {
    let err = error!("error macro test");
    assert!(err.to_string().contains("error macro test"));
    
    let err = error!(TestCode::B);
    assert!(err.is(TestCode::B));
}

#[test]
fn test_bail_macro() {
    fn produces_error() -> Result<()> {
        bail!("bailed out");
    }
    
    let res = produces_error();
    assert!(res.is_err());
    let err = res.unwrap_err();
    assert!(err.to_string().contains("bailed out"));
}

#[test]
fn test_bail_macro_with_code() {
    fn produces_error() -> Result<()> {
        bail!(TestCode::A, "bailed with code");
    }
    
    let res = produces_error();
    assert!(res.is_err());
    let err = res.unwrap_err();
    assert!(err.is(TestCode::A));
    assert!(err.to_string().contains("bailed with code"));
}

#[test]
fn test_ensure_macro() {
    fn check_condition(cond: bool) -> Result<()> {
        ensure!(cond, "condition failed");
        Ok(())
    }
    
    assert!(check_condition(true).is_ok());
    let res = check_condition(false);
    assert!(res.is_err());
    assert!(res.unwrap_err().to_string().contains("condition failed"));
}

#[test]
fn test_ensure_macro_no_args() {
    fn check_condition(cond: bool) -> Result<()> {
        ensure!(cond);
        Ok(())
    }
    
    assert!(check_condition(true).is_ok());
    let res = check_condition(false);
    assert!(res.is_err());
    assert!(res.unwrap_err().to_string().contains("error encountered"));
}

#[test]
fn test_ensure_macro_with_code() {
    fn check_condition(cond: bool) -> Result<()> {
        ensure!(cond, TestCode::B, "failed with code");
        Ok(())
    }
    
    assert!(check_condition(true).is_ok());
    let res = check_condition(false);
    assert!(res.is_err());
    let err = res.unwrap_err();
    assert!(err.is(TestCode::B));
    assert!(err.to_string().contains("failed with code"));
}