#log #logging #tracing

tracing-unwrap

Extension traits for logging failed unwraps to a tracing subscriber

5 unstable releases

0.10.0 Nov 4, 2022
0.9.2 Aug 27, 2020
0.9.1 Aug 10, 2020
0.9.0 Aug 10, 2020
0.0.1 Aug 9, 2020

#57 in Debugging

Download history 405/week @ 2022-10-14 386/week @ 2022-10-21 455/week @ 2022-10-28 1403/week @ 2022-11-04 583/week @ 2022-11-11 477/week @ 2022-11-18 401/week @ 2022-11-25 310/week @ 2022-12-02 583/week @ 2022-12-09 570/week @ 2022-12-16 293/week @ 2022-12-23 316/week @ 2022-12-30 440/week @ 2023-01-06 426/week @ 2023-01-13 628/week @ 2023-01-20 401/week @ 2023-01-27

1,957 downloads per month
Used in 10 crates (5 directly)

Apache-2.0/MIT

18KB
157 lines

tracing-unwrap

This crate provides .unwrap_or_log() and .expect_or_log() methods on Result and Option types that log failed unwraps to a tracing::Subscriber. This is useful when, for example, you are logging to syslog or a database, and you want your unwrap failures to show up there instead of being printed to stderr.

Its API aims to mirror Rust's std — see all the supported methods below. Failed unwraps are logged at a level of ERROR.

crates.io Documentation License

Usage

Add the following to your Cargo.toml:

tracing-unwrap = "0.10"

Next, bring the ResultExt and/or OptionExt traits into scope, and make use of the new logging methods.

use tracing_unwrap::ResultExt;

tracing_subscriber::fmt().init();
let not_great: Result<(), _> = Result::Err("not terrible");

// Logs the failed unwrap and panics
not_great.unwrap_or_log();

Methods

std method tracing-unwrap form trait
Result::unwrap() Result::unwrap_or_log() ResultExt
Result::expect(msg) Result::expect_or_log(msg) ResultExt
Result::unwrap_err() Result::unwrap_err_or_log() ResultExt
Result::expect_err(msg) Result::expect_err_or_log(msg) ResultExt
Option::unwrap() Option::unwrap_or_log() OptionExt
Option::expect(msg) Option::expect_or_log(msg) OptionExt
Option::unwrap_none() Option::unwrap_none_or_log() OptionExt
Option::expect_none(msg) Option::expect_none_or_log(msg) OptionExt

*†: no longer in std, see rust-lang/rust#62633*

Features

  • panic-quiet: causes failed unwraps to panic with an empty message.
    This feature is enabled by default — if you'd like the unwrap error message to also show in the panic message, disable default features in your Cargo.toml as follows:
    tracing-unwrap = { version = "0.10", default-features = false }

  • log-location: calls std::panic::Location::caller() to determine the location of a failed unwrap.

Dependencies

~415KB