Struct Backtrace

pub struct Backtrace { /* private fields */ }

Representation of an owned and self-contained backtrace.

This structure can be used to capture a backtrace at various points in a program and later used to inspect what the backtrace was at that time.

Backtrace supports pretty-printing of backtraces through its Debug implementation.

Required features

This function requires the std feature of the backtrace crate to be enabled, and the std feature is enabled by default.

Implementations

impl Backtrace

pub fn new() -> Backtrace

Captures a backtrace at the callsite of this function, returning an owned representation.

This function is useful for representing a backtrace as an object in Rust. This returned value can be sent across threads and printed elsewhere, and the purpose of this value is to be entirely self contained.

Note that on some platforms acquiring a full backtrace and resolving it can be extremely expensive. If the cost is too much for your application it’s recommended to instead use Backtrace::new_unresolved() which avoids the symbol resolution step (which typically takes the longest) and allows deferring that to a later date.

Examples

use backtrace::Backtrace;

let current_backtrace = Backtrace::new();

Required features

This function requires the std feature of the backtrace crate to be enabled, and the std feature is enabled by default.

pub fn new_unresolved() -> Backtrace

Similar to new except that this does not resolve any symbols, this simply captures the backtrace as a list of addresses.

At a later time the resolve function can be called to resolve this backtrace’s symbols into readable names. This function exists because the resolution process can sometimes take a significant amount of time whereas any one backtrace may only be rarely printed.

Examples

use backtrace::Backtrace;

let mut current_backtrace = Backtrace::new_unresolved();
println!("{current_backtrace:?}"); // no symbol names
current_backtrace.resolve();
println!("{current_backtrace:?}"); // symbol names now present

Required features

This function requires the std feature of the backtrace crate to be enabled, and the std feature is enabled by default.

pub fn frames(&self) -> &[BacktraceFrame]

Returns the frames from when this backtrace was captured.

The first entry of this slice is likely the function Backtrace::new, and the last frame is likely something about how this thread or the main function started.

Required features

This function requires the std feature of the backtrace crate to be enabled, and the std feature is enabled by default.

pub fn resolve(&mut self)

If this backtrace was created from new_unresolved then this function will resolve all addresses in the backtrace to their symbolic names.

If this backtrace has been previously resolved or was created through new, this function does nothing.

Required features

This function requires the std feature of the backtrace crate to be enabled, and the std feature is enabled by default.

Trait Implementations

impl Clone for Backtrace

fn clone(&self) -> Backtrace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Backtrace

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

Formats the value using the given formatter.

impl Default for Backtrace

fn default() -> Backtrace

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Backtrace

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Vec<BacktraceFrame>> for Backtrace

fn from(frames: Vec<BacktraceFrame>) -> Self

Converts to this type from the input type.

impl Into<Vec<BacktraceFrame>> for Backtrace

fn into(self) -> Vec<BacktraceFrame>

Converts this type into the (usually inferred) input type.

impl Serialize for Backtrace

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.