#failure #error #perfect #convenience #string #macro #cli

cli-failure

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

1 stable release

1.0.0 Aug 3, 2023

#1786 in Rust patterns


Used in doc-sync

MIT license

7KB
75 lines

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(())
}

No runtime deps