16 releases

0.6.1 Oct 22, 2023
0.6.0 Jul 30, 2023
0.5.1 Apr 25, 2021
0.5.0 Nov 21, 2020
0.2.2 Jun 29, 2019

#20 in Value formatting

Download history 6897/week @ 2024-01-03 6312/week @ 2024-01-10 6834/week @ 2024-01-17 5949/week @ 2024-01-24 5935/week @ 2024-01-31 6331/week @ 2024-02-07 5554/week @ 2024-02-14 7136/week @ 2024-02-21 7259/week @ 2024-02-28 7961/week @ 2024-03-06 7435/week @ 2024-03-13 7635/week @ 2024-03-20 6433/week @ 2024-03-27 7947/week @ 2024-04-03 7429/week @ 2024-04-10 7572/week @ 2024-04-17

30,944 downloads per month
Used in 101 crates (71 directly)

MIT/Apache

34KB
569 lines

color-backtrace

Crates.io docs.rs MIT licensed Apache 2.0 licensed

A Rust library that makes panics a little less painful by nicely colorizing them and printing the relevant source snippets.

[dependencies]
color-backtrace = { version = "0.6" }

To enable it, simply place this code somewhere in your app initialization code:

color_backtrace::install();

If you want to customize some settings, you can instead do:

use color_backtrace::{default_output_stream, BacktracePrinter};
BacktracePrinter::new().message("Custom message!").install(default_output_stream());

Features

  • Colorize backtraces to be easier on the eyes
  • Show source snippets if source files are found on disk
  • Print frames of application code vs dependencies in different color
  • Hide all the frames after the panic was already initiated
  • Hide language runtime initialization frames

Usage in tests

Unfortunately, defining custom init functions run before tests are started is currently not supported in Rust. Since initializing color-backtrace in each and every test is tedious even when wrapping it into a function, I recommended using the ctor crate for this.

Somewhere, preferably in your crate's main module, put the following code:

#[cfg(test)]
mod tests {
    use ctor::ctor;

    #[ctor]
    fn init_color_backtrace() {
        color_backtrace::install();
    }
}

You can also do this outside of a #[cfg(test)] section, in which case the panic handler is installed for both test and regular runs.

Screenshot

Screenshot

Dependencies

~3–12MB
~124K SLoC