color-eyre

A custom context for the [eyre] crate for colorful error reports, suggestions, and [tracing-error] support.

Setup

Add the following to your toml file:

toml [dependencies] eyre = "0.3.8" color-eyre = "0.2"

And then import the type alias from color-eyre for [eyre::Report] or [eyre::Result].

```rust use color_eyre::Report;

// or

fn example() -> color_eyre::Result<()> { # Ok(()) // ... } ```

Disabling tracing support

If you don't plan on using tracing_error and SpanTrace you can disable the tracing integration to cut down on unused dependencies:

toml [dependencies] eyre = "0.3.8" color-eyre = { version = "0.2", default-features = false }

Example

```rust,shouldpanic use coloreyre::{Help, Report}; use eyre::WrapErr; use tracing::{info, instrument}; use tracingerror::ErrorLayer; use tracingsubscriber::prelude::*; use tracing_subscriber::{fmt, EnvFilter};

fn main() -> Result<(), Report> { let fmtlayer = fmt::layer().withtarget(false); let filterlayer = EnvFilter::tryfromdefaultenv() .orelse(|| EnvFilter::try_new("info")) .unwrap();

tracing_subscriber::registry()
    .with(filter_layer)
    .with(fmt_layer)
    .with(ErrorLayer::default())
    .init();

Ok(read_config()?)

}

[instrument]

fn readfile(path: &str) -> Result<(), Report> { info!("Reading file"); Ok(std::fs::readto_string(path).map(drop)?) }

[instrument]

fn readconfig() -> Result<(), Report> { readfile("fakefile") .wraperr("Unable to read config") .suggestion("try using a file that exists next time") } ```

Minimal Report Format

Short Report Format (with RUST_LIB_BACKTRACE=1)

Full Report Format (with RUST_LIB_BACKTRACE=full)

Explanation

This crate works by defining a Context type which implements [eyre::EyreContext] and a pair of type aliases for setting this context type as the parameter of [eyre::Report].

```rust use color_eyre::Context;

pub type Report = eyre::Report; pub type Result = core::result::Result; ```

Features

• captures a [backtrace::Backtrace] and prints using [color-backtrace]
• captures a [tracing_error::SpanTrace] and prints using [color-spantrace]
• Only capture SpanTrace by default for better performance.
• display source lines when RUST_LIB_BACKTRACE=full is set
• store help text via [Help] trait and display after final report

License

<sup>Licensed under either of Apache License, Version 2.0 or MIT license at your option.</sup>

<sub>Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.</sub>