rassert_rs/lib.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
/// Helper macro to return an Err if the expression fails.
///
/// # Example
/// ```rust
/// use rassert_rs::rassert;
///
/// enum MyError {
/// SaulBadman,
/// }
///
/// fn test() -> Result<i32, MyError> {
/// rassert!(42 != 42, MyError::SaulBadman);
/// Ok(72)
/// }
///
/// fn main() {
/// assert!(test().is_err());
/// }
/// ```
#[macro_export]
macro_rules! rassert {
($expr: expr, $err: expr) => {
let _ = if $expr {
Ok(())
} else {
Err($err)
}?;
};
}
/// Helper macro to cleanly execute an expression and return out of the function if it fails.
///
/// # Example
/// ```rust
/// use rassert_rs::rassert_notify;
///
/// fn main() {
/// rassert_notify!(42 != 42, println!("Yikes"));
/// // Prints 'Yikes'
/// }
/// ```
#[macro_export]
macro_rules! rassert_notify {
($expr: expr, $notify: expr) => {
if !$expr {
$notify;
return;
}
};
}
/// Helper macro to cleanly execute an expression and continue a loop if it fails.
///
/// # Example
/// ```rust
/// use rassert_rs::rassert_notify_continue;
///
/// fn main() {
/// let mut i = 1;
/// while i != 5 {
/// i += 1;
/// rassert_notify_continue!(42 != 42, println!("Yikes"));
/// // Prints 'Yikes' and continues the loop
/// }
/// }
/// ```
#[macro_export]
macro_rules! rassert_notify_continue {
($expr: expr, $notify: expr) => {
if !$expr {
$notify;
continue;
}
};
}
/// Helper macro to cleanly execute an expression and break a loop if it fails.
///
/// # Example
/// ```rust
/// use rassert_rs::rassert_notify_break;
///
/// fn main() {
/// let mut i = 1;
/// while i != 5 {
/// rassert_notify_break!(42 != 42, println!("Yikes"));
/// // Prints 'Yikes' and breaks the loop
/// i += 1;
/// }
/// assert_eq!(i, 1);
/// }
/// ```
#[macro_export]
macro_rules! rassert_notify_break {
($expr: expr, $notify: expr) => {
if !$expr {
$notify;
break;
}
};
}
#[cfg(test)]
mod tests {
use crate::{rassert, rassert_notify};
struct TestError;
fn driver(f: impl Fn() -> Result<(), TestError>) -> Result<(), TestError> {
f()
}
#[test]
fn check_ok() {
let result = driver(|| {
rassert!(1 == 1, TestError);
Ok(())
});
assert!(result.is_ok());
}
#[test]
fn check_err() {
let result = driver(|| {
rassert!(1 != 1, TestError);
Ok(())
});
assert!(result.is_err());
}
#[allow(unused_assignments)]
#[test]
fn check_notify() {
let mut var = 72;
rassert_notify!(42 != 42, var = 42);
assert_eq!(var, 42);
}
#[allow(unused_assignments)]
#[test]
fn check_notify_continue() {
let mut var = 72;
while var != 42 {
rassert_notify_continue!(42 != 42, var = 42);
}
assert_eq!(var, 42);
}
#[allow(unused_assignments)]
#[test]
fn check_notify_break() {
let mut var = 72;
loop {
rassert_notify_break!(42 != 42, var = 42);
}
assert_eq!(var, 42);
}
}