anyhow-http 0.4.3

Customizable HTTP errors built on anyhow
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

/// Construct an ad-hoc [`Error`](anyhow::Error) from a status code, optional source error and formatted reason.
///
/// ```
/// # use anyhow::anyhow;
/// # use anyhow_http::http_error;
/// fn foo() -> anyhow::Result<()> {
///     const CODE: i32 = 1234;
///     Err(http_error!(BAD_REQUEST, "invalid payload, code {}", CODE))?;
///
///     // with source
///     let source = anyhow!("source error");
///     Err(http_error!(BAD_REQUEST, source = source, reason = "invalid payload, code {}", CODE))?;
///     Ok(())
/// }
/// ```
#[macro_export]
macro_rules! http_error{
    ($status_code:ident, $reason:literal) => {
        ::anyhow::Error::from($crate::HttpError::from_static($crate::http::StatusCode::$status_code, $reason))
    };
    ($status_code:ident $(, source = $src:expr)? $(, reason = $($arg:tt)*)?) => {{
        let http_error
            = $crate::HttpError::from_status_code($crate::http::StatusCode::$status_code)
            $(
                .with_source_err($src)
             )?
            $(
                .with_reason(std::format!($($arg)*))
             )?;
        ::anyhow::Error::from(http_error)
    }};
    ($status_code:ident $(, $($arg:tt)*)?) => {
        ::anyhow::Error::from($crate::http_error!($status_code $(, reason = $($arg)*)?))
    };
}

/// Shorthand macro to return early with an [`Error`](anyhow::Error).
///
/// Example:
/// ```
/// # use anyhow_http::http_error_bail;
/// fn foo() -> anyhow::Result<()> {
///     http_error_bail!(BAD_REQUEST, "invalid payload")
/// }
/// ```
#[macro_export]
macro_rules! http_error_bail {
    ($status_code:ident $(, source = $src:expr)? $(, reason = $($arg:tt)*)?) => {
        return Err($crate::http_error!($status_code $(, source = $src)? $(, reason = $($arg)*)?).into())
    };
    ($status_code:ident $(, $($arg:tt)*)?) => {
        return Err($crate::http_error!($status_code $(, reason = $($arg)*)?).into())
    };
}

#[cfg(test)]
mod tests {

    use crate::*;
    use anyhow::anyhow;
    use http::StatusCode;

    #[test]
    fn http_error_status_code() {
        let e: HttpError = http_error!(BAD_REQUEST).into();
        assert_eq!(e.status_code, StatusCode::BAD_REQUEST);
    }

    #[test]
    fn http_error_only_reason() {
        let i = 1;
        let e: HttpError = http_error!(BAD_REQUEST, "error {}", i).into();
        assert_eq!(e.status_code, StatusCode::BAD_REQUEST);
        assert_eq!(e.reason, Some("error 1".into()));
    }

    #[test]
    fn http_error_status_and_source() {
        let source = anyhow!("an error");
        let e: HttpError = http_error!(BAD_REQUEST, source = source).into();
        assert_eq!(e.status_code, StatusCode::BAD_REQUEST);
        assert!(e.source.is_some());
    }

    #[test]
    fn http_error_status_source_and_format() {
        let source = anyhow!("an error");
        let e: HttpError = http_error!(BAD_REQUEST, source = source, reason = "error {}", 1).into();
        assert_eq!(e.status_code, StatusCode::BAD_REQUEST);
        assert!(e.source.is_some());
        assert_eq!(e.reason, Some("error 1".into()));
    }

    #[test]
    fn http_error_bridge() {
        let _err: anyhow::Error = http_error!(BAD_REQUEST, "error",);
        let _err: HttpError = http_error!(BAD_REQUEST, "error",).into();
    }
}