err_trail 0.10.0

Add context to errors through logging
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

# err_trail

[<img alt="github" src="https://img.shields.io/badge/github-mcmah309/err_trail-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/mcmah309/err_trail)
[<img alt="crates.io" src="https://img.shields.io/crates/v/err_trail.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/err_trail)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-err_trail-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/err_trail)
[<img alt="test status" src="https://img.shields.io/github/actions/workflow/status/mcmah309/err_trail/ci.yml?branch=master&style=for-the-badge" height="20">](https://github.com/mcmah309/err_trail/actions/workflows/ci.yml)

Convience methods on `Result` and `Option` for logging when an `Err` or `None` is ecountered. Similar to [eros](https://github.com/mcmah309/eros) and [anyhow](https://github.com/dtolnay/anyhow)
but for logging.

## Feature Flags

**tracing** / **log** / **defmt** :
Enables support for the `tracing` or `log` or `defmt` crates. `error`, `warn`, `info`, `debug`, and `trace` methods are added to `Result` and are executed when the `Result` is an `Err` for logging purposes. They work similarly to `eros`'s and `anyhow`'s `.context(..)` method. e.g.
```rust
use err_trail::{ErrContext, ErrContextDisplay};


fn main() {
    let result: Result<(), &str> = Err("operation failed");

    let value: Result<(), &str> = result.error("If `Err`, this message is logged as error via tracing/log/defmt");
    let value: Result<(), &str> = result.warn("If `Err`, this message is logged as warn via tracing/log/defmt");
    let value: Result<(), &str> = result.with_error(|err| format!("If `Err`, this message is logged as error via tracing/log/defmt: {}", err));
    let value: Option<()> = result.ok_error(); // If `Err`, the `Err` is logged as error via tracing/log/defmt
    let value: Option<()> = result.with_warn(|err| format!("If `Err`, this message is logged as warn via tracing/log/defmt: {}", err)).ok();
    // ...etc.
}
```
This is useful tracing context around errors. e.g.
```rust,ignore
fn main() {
    let val = func().warn("`func` failed, here is some extra context like variable values")?;
    // or
    let val = func().consume_warn();
}
```
rather than
```rust,ignore
fn main() {
    let val = func().inspect_err(|err| tracing::warn!("`func` failed, here is some extra context like variable values"))?;
    // or
    let val = func().inspect_err(|err| tracing::warn!("{}", err)).ok();
}
```
## Notes For Libraries

This api is perfect for libraries. Downstream binaries ultimately decide the implementation for which logging provider to use, if any. If no implementations is selected, since all the above methods are inlined, the code becomes a no-op and will be optimized away during compilation.

## Guide

![Logging Guidelines](assets/logging_guideline.png)

**Additional Notes**
- If returning a `Result`, context should usually be `warn`.
- If consuming a `Result`, context should usually be `error`.
- `error` can also be used over `warn` for cases that should not be possible, but handling is preferred over panic in production.

## no_std

This crate supports `#![no_std]`.