#error-context #attributes #macro #add

macro fn-error-context

An attribute macro to add context to errors from a function

5 releases

0.2.1 Mar 21, 2023
0.2.0 Jul 7, 2021
0.1.2 Apr 21, 2021
0.1.1 Jul 11, 2020
0.1.0 Mar 29, 2020

#302 in Procedural macros

Download history 3650/week @ 2024-06-12 4587/week @ 2024-06-19 3978/week @ 2024-06-26 3709/week @ 2024-07-03 4648/week @ 2024-07-10 4542/week @ 2024-07-17 4084/week @ 2024-07-24 3951/week @ 2024-07-31 3668/week @ 2024-08-07 3512/week @ 2024-08-14 3173/week @ 2024-08-21 4058/week @ 2024-08-28 4075/week @ 2024-09-04 3255/week @ 2024-09-11 3406/week @ 2024-09-18 3302/week @ 2024-09-25

14,848 downloads per month
Used in 8 crates (7 directly)

MIT/Apache

14KB
55 lines

Crates.io Docs.rs

fn-error-context

An attribute macro to add context to errors from a function.

#[context("failed to parse config at `{}`", path.display())]
pub fn parse_config(path: &Path) -> anyhow::Result<u32> {
    let text = read_to_string(path)?;
    Ok(text.parse()?)
}

lib.rs:

This crate provides the context macro for adding extra error information to a function.

Works with anyhow, failure and any other error type which provides a context method taking a string.

#
use fn_error_context::context;

#[context("failed to parse config at `{}`", path.as_ref().display())]
pub fn parse_config(path: impl AsRef<Path>) -> anyhow::Result<u32> {
    let text = read_to_string(path.as_ref())?;
    Ok(text.parse()?)
}

let error = parse_config("not-found").unwrap_err();
assert_eq!(
    error.to_string(),
    "failed to parse config at `not-found`",
);
assert_eq!(
    error.source().unwrap().downcast_ref::<io::Error>().unwrap().kind(),
    io::ErrorKind::NotFound,
);

Dependencies

~265–710KB
~17K SLoC