Struct Backtrace

pub struct Backtrace {
    pub frames: Vec<*const c_void>,
}

A captured stack backtrace.

This type stores the backtrace of a captured stack at a certain point in time. The backtrace is represented as a list of instruction pointers.

Platform Support

The Backtrace API is only functional on the armv7a-vex-v5 platform target. At the moment, this target only platform that vexide supports, however this may change in the future.

Additionally, backtraces will be unsupported if vexide is compiled without the unwind feature.

Example

let backtrace = Backtrace::capture();
println!("{backtrace}");

Symbolication

The number stored in each frame is not particularly meaningful to humans on its own. Using a tool such as llvm-symbolizer or addr2line, it can be turned into a function name and line number to show what functions were being run at the time of the backtrace’s capture.

$ llvm-symbolizer -p -e ./target/armv7a-vex-v5/debug/program_name 0x380217b 0x380209b
my_function at /path/to/project/src/main.rs:30:14

main at /path/to/project/src/main.rs:21:9

Fields

frames: Vec<*const c_void>

The instruction pointers of each frame in the backtrace.

Implementations

impl Backtrace

pub fn capture() -> Self

Captures a backtrace at the current point of execution.

If a backtrace could not be captured, an empty backtrace is returned.

Platform Support

Backtraces will be empty on non-vex targets (e.g. WebAssembly) or when the unwind feature is disabled.

Trait Implementations

impl Clone for Backtrace

fn clone(&self) -> Backtrace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Backtrace

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

Formats the value using the given formatter.

impl Display for Backtrace

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

Formats the value using the given formatter.

impl PartialEq for Backtrace

fn eq(&self, other: &Backtrace) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Backtrace

impl StructuralPartialEq for Backtrace