error-stack-macros2 0.2.0

Community-made procedural macros for error-stack.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

# `error-stack-macros2`

[![crates.io latest version](https://img.shields.io/crates/v/error-stack-macros2?label=version&logo=rust)](https://crates.io/crates/error-stack-macros2)
[![crates.io downloads](https://img.shields.io/crates/d/error-stack-macros2)](https://crates.io/crates/error-stack-macros2)
[![Tests status](https://img.shields.io/github/actions/workflow/status/LuisFerLCC/error-stack-macros2/test.yml?branch=master&label=tests)](https://github.com/LuisFerLCC/error-stack-macros2/actions/workflows/test.yml)
[![Contributor Covenant Code of Conduct](https://img.shields.io/badge/Contributor%20Covenant-3.0-5e0d73?logo=contributorcovenant)](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CODE_OF_CONDUCT.md)

Community-made procedural macros for [`error-stack`].

## Example

Here is the same example shown in the [`error-stack`] `README`, modified to
use the macros provided by this crate:

```rust
use error_stack::{Report, ResultExt};
use error_stack_macros2::Error;

#[derive(Debug, Error)]
#[display("invalid experiment description")]
struct ParseExperimentError;

fn parse_experiment(
    description: &str
) -> Result<(u64, u64), Report<ParseExperimentError>> {
    let value = description
        .parse::<u64>()
        .attach_with(|| {
            format!("{description:?} could not be parsed as experiment")
        })
        .change_context(ParseExperimentError)?;

    Ok((value, 2 * value))
}

#[derive(Debug, Error)]
#[display("experiment error: could not run experiment")]
struct ExperimentError;

fn start_experiments(
    experiment_ids: &[usize],
    experiment_descriptions: &[&str],
) -> Result<Vec<u64>, Report<ExperimentError>> {
    let experiments = experiment_ids
        .iter()
        .map(|exp_id| {
            let description = experiment_descriptions
                .get(*exp_id)
                .ok_or_else(|| {
                    Report::new(ExperimentError)
                        .attach(format!(
                            "experiment {exp_id} has no valid description")
                        )
                })?;

            let experiment = parse_experiment(description)
                .attach(format!("experiment {exp_id} could not be parsed"))
                .change_context(ExperimentError)?;

            Ok(move || experiment.0 * experiment.1)
        })
        .collect::<Result<Vec<_>, Report<ExperimentError>>>()
        .attach("unable to set up experiments")?;

    Ok(experiments.iter().map(|experiment| experiment()).collect())
}

let experiment_ids = &[0, 2];
let experiment_descriptions = &["10", "20", "3o"];
let err = start_experiments(experiment_ids, experiment_descriptions)
    .unwrap_err();

assert_eq!(err.to_string(), "experiment error: could not run experiment");
```

## Support

Need help using `error-stack-macros2`? Don't hesitate to reach out on
[GitHub Discussions](https://github.com/LuisFerLCC/error-stack-macros2/discussions/categories/q-a)!

## Links

-   [Documentation]
-   [GitHub](https://github.com/LuisFerLCC/error-stack-macros2)
-   [crates.io](https://crates.io/crates/error-stack-macros2)

## Contributing

Before creating an issue, please consider the following:

-   Refer to the [documentation] to
    make sure the error is actually a bug and not a mistake of your own.
-   Make sure the issue hasn't already been reported or suggested.
-   Please report any security vulnerabilities privately through
    [Security Advisories](https://github.com/LuisFerLCC/error-stack-macros2/security/advisories/new).
-   After following these steps, you can file an issue using one of our
    [templates](https://github.com/LuisFerLCC/error-stack-macros2/issues/new/choose).
    Please make sure to follow our
    [Code of Conduct](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CODE_OF_CONDUCT.md).
-   If you wish to [submit a pull request](https://github.com/LuisFerLCC/error-stack-macros2/compare)
    alongside your issue, please follow our
    [contribution guidelines](https://github.com/LuisFerLCC/error-stack-macros2/blob/master/.github/CONTRIBUTING.md).

## Disclaimer

This crate is not affiliated with the official [`error-stack`] crate or its
maintainers.

[`error-stack`]: https://crates.io/crates/error-stack
[documentation]: https://docs.rs/error-stack-macros2