Struct Backtrace

pub struct Backtrace<const N: usize> {
    pub frames: ArrayVec<usize, N>,
    pub frames_omitted: bool,
}

A backtrace consisting of a list of instruction pointer addresses.

The backtrace does not allocate any memory, which allows it to be used in environments where dynamic allocation cannot be used such as signal handlers or interrupt handlers.

The N generic constant controls the maximum number of entries that should be included in the backtrace. Usually 16 frames are enough to get sufficient context from a crash.

Fields

frames: ArrayVec<usize, N>

List of instruction pointer addresses in each frame, from most recent to oldest.

These are not precise return address: the addresses are adjusted so that they point within the bounds of the caller function. This avoids issues when a call instruction is the last instruction in a function, which would otherwise result in a return address pointing at the start of the next function.

frames_omitted: bool

Whether any frames have been omitted due to exceeding the capacity of the ArrayVec.

Implementations

impl<const N: usize> Backtrace<N>

pub fn capture() -> Self

Captures a backtrace from the current call point.

The first frame of the backtrace is the caller of Backtrace::capture.

Examples found in repository

examples/backtrace.rs (line 4)

fn main() {
    let bt = Backtrace::<16>::capture();
    println!("Backtrace:");
    for frame in bt.frames {
        println!("  {:#x}", adjust_for_pic(frame));
    }
    if bt.frames_omitted {
        println!(" ... <frames omitted>");
    }
}

Trait Implementations

impl<const N: usize> Clone for Backtrace<N>

fn clone(&self) -> Backtrace<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Backtrace<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Backtrace<N>

fn default() -> Backtrace<N>

Returns the “default value” for a type.