Crate cli_failure 

cli-failure

Provides Failure(String) implementing std::error::Error. Includes convenience macros making it perfect for usage with wrap-match in CLIs.

This crate should not be used in libraries. Instead, use something like thiserror. For libraries, it is much better to have specific errors so library users can handle them better.

Documentation | crates.io

Example

// wrap-match is not required, but it is highly recommended
fn example() -> Result<(), Box<dyn Error>> {
    let result = "bad";
    // With convenience macros

    // These two lines are the same
    bail!("something {result} happened");
    return failure!("something {result} happened");

    return failure_raw!("something {result} happened").err_boxed();
    return Err(failure_raw!("something {result} happened").boxed());
    // Manually
    return Failure(format!("something {result} happened")).err_boxed();
    return Err(Failure(format!("something {result} happened")).boxed());
    Ok(())
}

Macros

bail

Returns a Failure after calling Failure::err_boxed(). Any arguments to this macro will be passed to format_args!, allowing formatting specifiers to be used.

failure

Constructs a Failure and calls Failure::err_boxed(). Any arguments to this macro will be passed to format_args!, allowing formatting specifiers to be used.

failure_raw

Constructs a Failure. Any arguments to this macro will be passed to format_args!, allowing formatting specifiers to be used.

Structs

Failure

It is recommend to use failure! or failure_raw! to construct a Failure as this saves typing "...".to_owned() or format!("...").