trace-err 1.0.0

A small extension to the tracing crate, which provides a single method 'trace_expect()' for Result<T, E> and Option<T>
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

# Trace_Err

![no_std](https://img.shields.io/badge/no__std-compatible-success)

A small extension to the [tracing](https://crates.io/crates/tracing) crate, which provides a single method for `core::result::Result<T, E>` and `core::option::Option<T>`.

Adds `trace_expect` to `Result`, which invoke the `tracing::error!` macro (in case of `Result::Err`) in _addition_ to unwrapping/expecting the `Result`.

Adds `trace_expect` to `Option`, which invoke the `tracing::error!` macro (in case of `Option::None`) in _addition_ to unwrapping/expecting the `Option`.

Shamelessly derived from the [Log_Err](https://crates.io/crates/log_err) crate.

Shorthand for:

```rust
use tracing::error;

fn something() -> Result<(), &'static str> {Err("there was some problem")}

let msg = "Some message";
something().map_err(|e| tracing::error!("{}: {:?}", msg, e)).expect(msg)
```

Example:

```rust
use std::fs::File;
use trace_err::*;

let mut file = File::open("foo.txt").trace_expect("Error creating file");
```
```text
# Error will be traced with the error! macro
2024-06-12T09:31:23.933299Z ERROR expect: trace-err/lib.rs:87:39: Error creating file: Os { code: 2, kind: NotFound, message: "No such file or directory" }

# Main program panic'ing with same message
thread 'main' panicked at trace-err/lib.rs:87:39:
Error creating file: Os { code: 2, kind: NotFound, message: "No such file or directory" }
```

## no_std Support

This crate is `no_std` compatible and can be used in embedded or bare-metal environments. The library uses only `core` types and has no heap allocations. All dependencies (`tracing` and its transitive dependencies) also support `no_std`.