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

//! This library is inspired in the `ensure` and `bail` macros from `anyhow`. The difference is that it is not tied to anyhow's types.
//! Many libraries have their own error types and using the anyhow's `ensure` macro doesn't work because it returns an anyhow error. This library intends to work with any type.
//! This library also provides the `assure` macro, that does the same but evaluates to a `Result` instead of returning. This is useful for using inside `try` blocks.

/// Ensures the condition is met. This evaluates to a `Result<(), ERROR>`
/// This macro is equivalent to `if !cond { Err(error) } else { Ok(()) }`.
/// Example:
/// ```
/// use bail_out::*;
/// fn test_err() -> Result<(), &'static str> {
///    assure!(false, "error")
/// }
/// assert_eq!(test_err(), Err("error"));
///
/// fn test_ok() -> Result<(), &'static str> {
///    assure!(true, "error")
/// }
/// assert!(test_ok().is_ok());
/// ```
#[macro_export]
macro_rules! assure {
    ($cond:expr, $error:expr) => {
        if !$cond {
            Err($error)
        } else {
            Ok(())
        }
    };
}

/// Ensures the condition is met or returns the value. This evaluates to a `Result<VALUE, ERROR>`
/// This macro is equivalent to `if !cond { Err(error) } else { Ok(value) }`.
/// Example:
/// ```
/// use bail_out::*;
/// fn test_err() -> Result<&'static str, &'static str> {
///    assure_or!(false, "ok", "error")
/// }
/// assert_eq!(test_err(), Err("error"));
///
/// fn test_ok() -> Result<&'static str, &'static str> {
///    assure_or!(true, "ok", "error")
/// }
/// assert_eq!(test_ok(), Ok("ok"));
/// ```
#[macro_export]
macro_rules! assure_or {
    ($cond:expr, $ok: expr, $error:expr) => {
        if !$cond {
            Err($error)
        } else {
            Ok($ok)
        }
    };
}

/// Ensures the condition is not met. This evaluates to a `Result<(), ERROR>`
/// This macro is equivalent to `if cond { Err(error) } else { Ok(()) }`.
/// Example:
/// ```
/// use bail_out::*;
/// fn test_err() -> Result<(), &'static str> {
///    assure_not!(true, "error")
/// }
/// assert_eq!(test_err(), Err("error"));
///
/// fn test_ok() -> Result<(), &'static str> {
///    assure_not!(false, "error")
/// }
/// assert!(test_ok().is_ok());
/// ```
#[macro_export]
macro_rules! assure_not {
    ($cond:expr, $error:expr) => {
        if $cond {
            Err($error)
        } else {
            Ok(())
        }
    };
}

/// Ensures the condition is not met or returns the value. This evaluates to a `Result<VALUE, ERROR>`
/// This macro is equivalent to `if cond { Err(error) } else { Ok(value) }`.
/// Example:
/// ```
/// use bail_out::*;
/// fn test_err() -> Result<&'static str, &'static str> {
///    assure_not_or!(true, "ok", "error")
/// }
/// assert_eq!(test_err(), Err("error"));
///
/// fn test_ok() -> Result<&'static str, &'static str> {
///    assure_not_or!(false, "ok", "error")
/// }
/// assert_eq!(test_ok(), Ok("ok"));
/// ```
#[macro_export]
macro_rules! assure_not_or {
    ($cond:expr, $ok:expr, $error:expr) => {
        if $cond {
            Err($error)
        } else {
            Ok($ok)
        }
    };
}

/// Return early with an error if the condition is false. This ensures the condition is met.
/// This macro is equivalent to `if !cond { return Err(error) }`.
/// Example:
/// ```
/// use bail_out::*;
/// fn test_err() -> Result<(), &'static str> {
///    ensure!(false, "error");
///    Ok(())
/// }
/// assert_eq!(test_err(), Err("error"));
///
/// fn test_ok() -> Result<(), &'static str> {
///    ensure!(true, "ok");
///    Ok(())
/// }
/// assert_eq!(test_ok(), Ok(()));
/// ```
#[macro_export]
macro_rules! ensure {
    ($cond:expr, $error:expr) => {
        if !$cond {
            $crate::bail!($error);
        }
    };
}

/// Return early with an error if the condition is true. This ensures the condition is not met.
/// This macro is equivalent to `if cond { return Err(error) }`.
/// Example:
/// ```
/// use bail_out::*;
/// fn test_err() -> Result<(), &'static str> {
///    ensure_not!(true, "error");
///    Ok(())
/// }
/// assert_eq!(test_err(), Err("error"));
///
/// fn test_ok() -> Result<(), &'static str> {
///    ensure_not!(false, "ok");
///    Ok(())
/// }
/// assert_eq!(test_ok(), Ok(()));
/// ```
#[macro_export]
macro_rules! ensure_not {
    ($cond:expr, $error:expr) => {
        if $cond {
            $crate::bail!($error);
        }
    };
}

/// Return early with an error.
/// This macro is equivalent to `return Err(error)`.
/// Example:
/// ```
/// use bail_out::*;
/// fn bail_test() -> Result<(), &'static str> {
///    bail!("error");
///    Ok(())
/// }
/// assert_eq!(bail_test(), Err("error"));
/// ```
#[macro_export]
macro_rules! bail {
    ($error:expr) => {
        return Err($error);
    };
}

#[cfg(test)]
mod tests;