ca
context-attribute
cargo install context-attribute
ca

context-attribute

Set the error context using doc comments

by Yosh

1.0.0 (see all)License:MIT OR Apache-2.0
cargo install context-attribute
Readme

context-attribute

crates.io version build status downloads docs.rs docs

Set the error context using doc comments.

This is useful because instead of writing manual error messages to provide context to an error, it automatically derives it from doc comments. This works especially well for async contexts, where stack traces may not be persisted past yield points and thread boundaries. But contexts do.

Examples

use context_attribute::context;
use failure::{ensure, ResultExt};

/// Square a number if it's less than 10.
#[context]
fn square(num: usize) -> Result<usize, failure::Error> {
    ensure!(num < 10, "Number was too large");
    Ok(num * num)
}

fn main() -> Result<(), failure::Error> {
    let args = std::env::args();
    ensure!(args.len() == 2, "usage: square <num>");
    let input = args.skip(1).next().unwrap().parse()?;

    println!("result is {}", square(input)?);

    Ok(())
}


$ cargo run --example square 12
Error: ErrorMessage { msg: "Number was too large" }
Square a number if it's less than 10.

Installation

$ cargo add context-attribute

Safety

This crate uses #![deny(unsafe_code)] to ensure everything is implemented in 100% Safe Rust.

Contributing

Want to join us? Check out our "Contributing" guide and take a look at some of these issues:

References

None.

License

MIT OR Apache-2.0

GitHub Stars

51

LAST COMMIT

3yrs ago

MAINTAINERS

1

CONTRIBUTORS

1

OPEN ISSUES

6

OPEN PRs

1
VersionTagPublished
1.0.0
3yrs ago
No alternatives found
No tutorials found
Add a tutorial