Struct BacktracePrinter

pub struct BacktracePrinter { /* private fields */ }

Pretty-printer for backtraces and PanicInfo structs.

Implementations

impl BacktracePrinter

Builder functions.

pub fn new() -> Self

Alias for BacktracePrinter::default.

Examples found in repository

examples/custom_message.rs (line 4)

fn main() {
    BacktracePrinter::new()
        .message("Custom message!")
        .install(default_output_stream());
    assert_eq!(1, 2);
}

examples/force_color.rs (line 24)

fn main() {
    use color_backtrace::{termcolor::StandardStream, BacktracePrinter};
    let out = StandardStream::stderr(termcolor::ColorChoice::Always);
    BacktracePrinter::new().install(out);

    fn1();
}

pub fn color_scheme(self, colors: ColorScheme) -> Self

Alter the color scheme.

Defaults to ColorScheme::classic().

pub fn message(self, message: impl Into<String>) -> Self

Controls the “greeting” message of the panic.

Defaults to "The application panicked (crashed)".

Examples found in repository

examples/custom_message.rs (line 5)

fn main() {
    BacktracePrinter::new()
        .message("Custom message!")
        .install(default_output_stream());
    assert_eq!(1, 2);
}

pub fn verbosity(self, v: Verbosity) -> Self

Controls the verbosity level used when installed as panic handler.

Defaults to Verbosity::from_env().

pub fn lib_verbosity(self, v: Verbosity) -> Self

Controls the lib verbosity level used when formatting user provided traces.

Defaults to Verbosity::lib_from_env().

pub fn strip_function_hash(self, strip: bool) -> Self

Controls whether the hash part of functions is stripped.

Defaults to false.

pub fn print_addresses(self, val: bool) -> Self

Controls whether addresses (or module offsets if available) should be printed.

Defaults to false.

pub fn add_frame_filter(self, filter: Box<FilterCallback>) -> Self

Add a custom filter to the set of frame filters

Filters are run in the order they are added.

Example

use color_backtrace::{default_output_stream, BacktracePrinter};

BacktracePrinter::new()
    .add_frame_filter(Box::new(|frames| {
        frames.retain(|x| matches!(&x.name, Some(n) if !n.starts_with("blabla")))
    }))
    .install(default_output_stream());

pub fn clear_frame_filters(self) -> Self

Clears all filters associated with this printer, including the default filter

impl BacktracePrinter

Routines for putting the panic printer to use.

pub fn install(self, out: impl WriteColor + Sync + Send + 'static)

Install the color_backtrace handler with default settings.

Output streams can be created via default_output_stream() or using any other stream that implements termcolor::WriteColor.

Examples found in repository

examples/custom_message.rs (line 6)

fn main() {
    BacktracePrinter::new()
        .message("Custom message!")
        .install(default_output_stream());
    assert_eq!(1, 2);
}

examples/force_color.rs (line 24)

fn main() {
    use color_backtrace::{termcolor::StandardStream, BacktracePrinter};
    let out = StandardStream::stderr(termcolor::ColorChoice::Always);
    BacktracePrinter::new().install(out);

    fn1();
}

pub fn into_panic_handler( self, out: impl WriteColor + Sync + Send + 'static, ) -> Box<dyn Fn(&PanicInfo<'_>) + Sync + Send + 'static>

Create a color_backtrace panic handler from this panic printer.

This can be used if you want to combine the handler with other handlers.

pub fn print_trace( &self, trace: &Backtrace, out: &mut impl WriteColor, ) -> Result<(), Error>

Pretty-prints a backtrace::Backtrace to an output stream.

pub fn format_trace_to_string(&self, trace: &Backtrace) -> Result<String, Error>

Pretty-print a backtrace to a String, using VT100 color codes.

Examples found in repository

examples/fmt_to_string.rs (line 6)

fn main() -> Result<(), std::io::Error> {
    let trace = backtrace::Backtrace::new();
    let printer = BacktracePrinter::default();
    let str = printer.format_trace_to_string(&trace)?;

    if cfg!(windows) {
        println!(
            "Warning: on Windows, you'll have to enable VT100 \
             printing for your app in order for this to work \
             correctly. This example doesn't do this."
        );
    }

    println!("{}", str);

    Ok(())
}

pub fn print_panic_info( &self, pi: &PanicInfo<'_>, out: &mut impl WriteColor, ) -> Result<(), Error>

Pretty-prints a PanicInfo struct to an output stream.

Trait Implementations

impl Clone for BacktracePrinter

fn clone(&self) -> BacktracePrinter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BacktracePrinter

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BacktracePrinter

fn default() -> Self

Returns the “default value” for a type.