[−][src]Crate 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:
[dependencies]
eyre = "0.3.8"
color-eyre = "0.2"
And then import the type alias from color-eyre for eyre::Report
or eyre::Result
.
use color_eyre::Report; // or fn example() -> color_eyre::Result<()> { // ... }
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:
[dependencies]
eyre = "0.3.8"
color-eyre = { version = "0.2", default-features = false }
Example
use color_eyre::{Help, Report}; use eyre::WrapErr; use tracing::{info, instrument}; use tracing_error::ErrorLayer; use tracing_subscriber::prelude::*; use tracing_subscriber::{fmt, EnvFilter}; fn main() -> Result<(), Report> { let fmt_layer = fmt::layer().with_target(false); let filter_layer = EnvFilter::try_from_default_env() .or_else(|_| EnvFilter::try_new("info")) .unwrap(); tracing_subscriber::registry() .with(filter_layer) .with(fmt_layer) .with(ErrorLayer::default()) .init(); Ok(read_config()?) } #[instrument] fn read_file(path: &str) -> Result<(), Report> { info!("Reading file"); Ok(std::fs::read_to_string(path).map(drop)?) } #[instrument] fn read_config() -> Result<(), Report> { read_file("fake_file") .wrap_err("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
.
use color_eyre::Context; pub type Report = eyre::Report<Context>; pub type Result<T, E = Report> = core::result::Result<T, E>;
Features
- captures a
backtrace::Backtrace
and prints usingcolor-backtrace
- captures a
tracing_error::SpanTrace
and prints usingcolor-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
Structs
Context | A custom context type for |
Traits
Help | A helper trait for attaching help text to errors to be displayed after the chain of errors |
Type Definitions
Report | A type alias for |
Result | A type alias for |