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
#![allow(clippy::crate_in_macro_def)]
/// # Description
/// This macro handles errors inserting error handling logic for a given `Result<T, crate::error::Error<'a>>`
/// it is used by passing in a `Sender<crate::status::Status>` as the first parameter
/// and a `Result<T, crate::error::Error<'a>>` as the second parameter.
///
/// NOTE: There are 3 caveats to using this macro:
/// 1. can only be used within async functions since status needs to be send over async channel
/// 2. The macro must be used within a loop since it calls `continue` on error. If `unwraps/expects` are used within a function
/// without a loop, you should make the function return a result and handle the result within a main loop
/// 3. The macro must be able to reference the user defined function `crate::status::handle_error(T, U) -> ErrorBranch;` where U is the output
/// of `e.into()`
///
/// # Example
/// ``` ignore
/// let (tx_status: Sender<Status>, rx_status) = async_channel::unbounded();
/// let variable = handle_result!(
/// tx_status,
/// type_.try_into()
/// );
/// ```
#[macro_export]
macro_rules! handle_result {
($sender:expr, $res:expr) => {
match $res {
Ok(val) => val,
Err(e) => {
// handle error
let res = crate::status::handle_error(&$sender, e.into()).await;
match res {
error_handling::ErrorBranch::Break => break,
error_handling::ErrorBranch::Continue => continue,
}
}
}
};
}
pub enum ErrorBranch {
Break,
Continue,
}