# Struct std::backtrace::Backtrace

1.65.0 · source ·

    pub struct Backtrace { /* private fields */ }

Expand description

A captured OS thread stack backtrace.

This type represents a stack backtrace for an OS thread captured at a previous point in time. In some instances the `Backtrace` type may internally be empty due to configuration. For more information see `Backtrace::capture`.

## Implementations§

source§

### impl Backtrace

source

#### pub fn capture() -> Backtrace

Capture a stack backtrace of the current thread.

This function will capture a stack backtrace of the current OS thread of execution, returning a `Backtrace` type which can be later used to print the entire stack trace or render it to a string.

This function will be a noop if the `RUST_BACKTRACE` or `RUST_LIB_BACKTRACE` backtrace variables are both not set. If either environment variable is set and enabled then this function will actually capture a backtrace. Capturing a backtrace can be both memory intensive and slow, so these environment variables allow liberally using `Backtrace::capture` and only incurring a slowdown when the environment variables are set.

To forcibly capture a backtrace regardless of environment variables, use the `Backtrace::force_capture` function.

source

#### pub fn force_capture() -> Backtrace

Forcibly captures a full backtrace, regardless of environment variable configuration.

This function behaves the same as `capture` except that it ignores the values of the `RUST_BACKTRACE` and `RUST_LIB_BACKTRACE` environment variables, always capturing a backtrace.

Note that capturing a backtrace can be an expensive operation on some platforms, so this should be used with caution in performance-sensitive parts of code.

const: 1.65.0 · source

#### pub const fn disabled() -> Backtrace

Forcibly captures a disabled backtrace, regardless of environment variable configuration.

source

#### pub fn status(&self) -> BacktraceStatus

Returns the status of this backtrace, indicating whether this backtrace request was unsupported, disabled, or a stack trace was actually captured.

source§

### impl<'a> Backtrace

source

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

🔬This is a nightly-only experimental API. (`backtrace_frames` #79676)

Returns an iterator over the backtrace frames.

## Trait Implementations§

source§

### impl Debug for Backtrace

source§

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

Formats the value using the given formatter. Read more
source§

### impl Display for Backtrace

source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl RefUnwindSafe for Backtrace

§

### impl Send for Backtrace

§

### impl Sync for Backtrace

§

### impl Unpin for Backtrace

§

### impl UnwindSafe for Backtrace

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> ToString for Twhere T: Display + ?Sized,

source§

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.