1/// Triggers a panic with a detailed bug report message, while ensuring the panic is ignored in coverage reports.
2///
3/// This macro is useful in situations where an unreachable code path is hit or when a bug occurs.
4///
5/// # Parameters
6///
7/// - `msg`: A string expression describing the cause of the panic or bug.
8///
9/// ```
10#[macro_export]
11macro_rules! bug {
12 ($msg:expr $(, $arg:tt)*) => {{
13let formatted_msg = format!($msg, $($arg)*);
14let full_message = format!(
15r#"
16This should never happen, sorry!
1718However, it did happen, so it must be a bug. Please report it to us!
1920Conjure Oxide is actively developed and maintained. We will get back to you as soon as possible.
2122You can help us by providing a minimal failing example.
2324Issue tracker: http://github.com/conjure-cp/conjure-oxide/issues
2526version: {}
27location: {}:{}:{}
2829{}
30"#, git_version::git_version!(),file!(),module_path!(),line!(), &formatted_msg);
3132panic!("{}", full_message);
33 }};
34}