http_types/
macros.rs

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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/// Return early with an error.
#[macro_export]
macro_rules! bail {
    ($msg:literal $(,)?) => {
        return $crate::private::Err($crate::format_err!($msg))
    };
    ($msg:expr $(,)?) => {
        return $crate::private::Err($crate::format_err!($msg))
    };
    ($msg:expr, $($arg:tt)*) => {
        return $crate::private::Err($crate::format_err!($msg, $($arg)*))
    };
}

/// Return early with an error if a condition is not satisfied.
///
/// This macro is equivalent to `if !$cond { return Err(From::from($err)); }`.
///
/// Analogously to `assert!`, `ensure!` takes a condition and exits the function
/// if the condition fails. Unlike `assert!`, `ensure!` returns an `Error`
/// rather than panicking.
#[macro_export]
macro_rules! ensure {
    ($cond:expr, $msg:literal $(,)?) => {
        if !$cond {
            return $crate::private::Err($crate::format_err!($msg))
        }
    };
    ($cond:expr, $msg:expr $(,)?) => {
        if !$cond {
            return $crate::private::Err($crate::format_err!($msg))
        }
    };
    ($cond:expr, $msg:expr, $($arg:tt)*) => {
        if !$cond {
            return $crate::private::Err($crate::format_err!($msg, $($arg)*))
        }
    };
}

/// Return early with an error if two expressions are not equal to each other.
///
/// This macro is equivalent to `if $left != $right { return Err(From::from($err)); }`.
///
/// Analogously to `assert_eq!`, `ensure_eq!` takes two expressions and exits the function
/// if the expressions are not equal. Unlike `assert_eq!`, `ensure_eq!` returns an `Error`
/// rather than panicking.
#[macro_export]
macro_rules! ensure_eq {
    ($left:expr, $right:expr, $msg:literal $(,)?) => {
        if $left != $right {
            return $crate::private::Err($crate::format_err!($msg))
        }
    };
    ($left:expr, $right:expr, $msg:expr $(,)?) => {
        if $left != $right {
            return $crate::private::Err($crate::format_err!($msg))
        }
    };
    ($left:expr, $right:expr, $msg:expr, $($arg:tt)*) => {
        if $left != $right {
            return $crate::private::Err($crate::format_err!($msg, $($arg)*))
        }
    };
}

/// Construct an ad-hoc error from a string.
///
/// This evaluates to an `Error`. It can take either just a string, or a format
/// string with arguments. It also can take any custom type which implements
/// `Debug` and `Display`.
#[macro_export]
macro_rules! format_err {
    ($msg:literal $(,)?) => {
        // Handle $:literal as a special case to make cargo-expanded code more
        // concise in the common case.
        $crate::private::new_adhoc($msg)
    };
    ($err:expr $(,)?) => ({
        let error = $err;
        Error::new_adhoc(error)
    });
    ($fmt:expr, $($arg:tt)*) => {
        $crate::private::new_adhoc(format!($fmt, $($arg)*))
    };
}

/// Return early with an error and a status code.
#[doc(hidden)]
#[macro_export]
macro_rules! bail_status {
    ($status:literal, $msg:literal $(,)?) => {{
        return $crate::private::Err($crate::format_err_status!($status, $msg))
    }};
    ($status:literal, $msg:expr $(,)?) => {
        return $crate::private::Err($crate::format_err_status!($status, $msg))
    };
    ($status:literal, $msg:expr, $($arg:tt)*) => {
        return $crate::private::Err($crate::format_err_status!($status, $msg, $($arg)*))
    };
}

/// Return early with an error if a condition is not satisfied.
///
/// This macro is equivalent to `if !$cond { return Err(From::from($err)); }`.
///
/// Analogously to `assert!`, `ensure!` takes a condition and exits the function
/// if the condition fails. Unlike `assert!`, `ensure!` returns an `Error`
/// rather than panicking.
#[doc(hidden)]
#[macro_export]
macro_rules! ensure_status {
    ($cond:expr, $status:literal, $msg:literal $(,)?) => {
        if !$cond {
            return $crate::private::Err($crate::format_err_status!($status, $msg))
        }
    };
    ($cond:expr, $status:literal, $msg:expr $(,)?) => {
        if !$cond {
            return $crate::private::Err($crate::format_err_status!($status, $msg))
        }
    };
    ($cond:expr, $status:literal, $msg:expr, $($arg:tt)*) => {
        if !$cond {
            return $crate::private::Err($crate::format_err_status!($status, $msg, $($arg)*))
        }
    };
}

/// Return early with an error if two expressions are not equal to each other.
///
/// This macro is equivalent to `if $left != $right { return Err(From::from($err)); }`.
///
/// Analogously to `assert_eq!`, `ensure_eq!` takes two expressions and exits the function
/// if the expressions are not equal. Unlike `assert_eq!`, `ensure_eq!` returns an `Error`
/// rather than panicking.
#[doc(hidden)]
#[macro_export]
macro_rules! ensure_eq_status {
    ($left:expr, $right:expr, $status:literal, $msg:literal $(,)?) => {
        if $left != $right {
            return $crate::private::Err($crate::format_err_status!($status, $msg))
        }
    };
    ($left:expr, $right:expr, $status:literal, $msg:expr $(,)?) => {
        if $left != $right {
            return $crate::private::Err($crate::format_err_status!($status, $msg))
        }
    };
    ($left:expr, $right:expr, $status:literal, $msg:expr, $($arg:tt)*) => {
        if $left != $right {
            return $crate::private::Err($crate::format_err_status!($status, $msg, $($arg)*))
        }
    };
}

/// Construct an ad-hoc error from a string.
///
/// This evaluates to an `Error`. It can take either just a string, or a format
/// string with arguments. It also can take any custom type which implements
/// `Debug` and `Display`.
#[doc(hidden)]
#[macro_export]
macro_rules! format_err_status {
    ($status:literal, $msg:literal $(,)?) => {{
        // Handle $:literal as a special case to make cargo-expanded code more
        // concise in the common case.
        let mut err = $crate::private::new_adhoc($msg);
        err.set_status($status);
        err
    }};
    ($status:literal, $msg:expr $(,)?) => {{
        let mut err = $crate::private::new_adhoc($msg);
        err.set_status($status);
        err
    }};
    ($status:literal, $msg:expr, $($arg:tt)*) => {{
        let mut err = $crate::private::new_adhoc(format!($msg, $($arg)*));
        err.set_status($status);
        err
    }};
}