#trace #resolve #stack #runtime

backtrace

A library to acquire a stack trace (backtrace) at runtime in a Rust program

79 releases

0.3.67 Dec 14, 2022
0.3.66 Jul 7, 2022
0.3.65 Apr 18, 2022
0.3.64 Jan 28, 2022
0.1.4 Jul 16, 2015

#30 in Debugging

Download history 486716/week @ 2022-10-07 502554/week @ 2022-10-14 499653/week @ 2022-10-21 484338/week @ 2022-10-28 535932/week @ 2022-11-04 521992/week @ 2022-11-11 473372/week @ 2022-11-18 493302/week @ 2022-11-25 474558/week @ 2022-12-02 486782/week @ 2022-12-09 440094/week @ 2022-12-16 275760/week @ 2022-12-23 370240/week @ 2022-12-30 512549/week @ 2023-01-06 501523/week @ 2023-01-13 534538/week @ 2023-01-20

1,973,273 downloads per month
Used in 4,519 crates (344 directly)

MIT/Apache

230KB
5K SLoC

backtrace-rs

Documentation

A library for acquiring backtraces at runtime for Rust. This library aims to enhance the support of the standard library by providing a programmatic interface to work with, but it also supports simply easily printing the current backtrace like libstd's panics.

Install

[dependencies]
backtrace = "0.3"

Usage

To simply capture a backtrace and defer dealing with it until a later time, you can use the top-level Backtrace type.

use backtrace::Backtrace;

fn main() {
    let bt = Backtrace::new();

    // do_some_work();

    println!("{:?}", bt);
}

If, however, you'd like more raw access to the actual tracing functionality, you can use the trace and resolve functions directly.

fn main() {
    backtrace::trace(|frame| {
        let ip = frame.ip();
        let symbol_address = frame.symbol_address();

        // Resolve this instruction pointer to a symbol name
        backtrace::resolve_frame(frame, |symbol| {
            if let Some(name) = symbol.name() {
                // ...
            }
            if let Some(filename) = symbol.filename() {
                // ...
            }
        });

        true // keep going to the next frame
    });
}

License

This project is licensed under either of

at your option.

Contribution

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

Dependencies

~4MB
~82K SLoC