Struct failure::Backtrace

pub struct Backtrace { /* fields omitted */ }

A Backtrace.

This is an opaque wrapper around the backtrace provided by libbacktrace. A variety of optimizations have been performed to avoid unnecessary or ill-advised work:

• If this crate is compiled in no_std compatible mode, Backtrace is an empty struct, and will be completely compiled away.
• If this crate is run without the RUST_BACKTRACE environmental variable enabled, the backtrace will not be generated at runtime.
• Even if a backtrace is generated, the most expensive part of generating a backtrace is symbol resolution. This backtrace does not perform symbol resolution until it is actually read (e.g. by printing it). If the Backtrace is never used for anything, symbols never get resolved.

Even with these optimizations, including a backtrace in your failure may not be appropriate to your use case. You are not required to put a backtrace in a custom Fail type.

Implementations

impl Backtrace

pub fn new() -> Backtrace

Constructs a new backtrace. This will only create a real backtrace if the crate is compiled in std mode and the RUST_BACKTRACE environmental variable is activated.

pub fn is_empty(&self) -> bool

Returns true if displaying this backtrace would be an empty string.

Trait Implementations

impl Debug for Backtrace

fn fmt(&self, f: &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 Display for Backtrace

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

Formats the value using the given formatter.