Struct Trace

pub struct Trace<T>(/* private fields */);

Wrapper type containing a value and the backtrace to the address where it was wrapped.

It is transparent and forwards Hash, PartialOrd, Ord, PartialEq and Eq to the wrapped type. Deref and DerefMut implementations are provided to make it somewhat easy to work with the contained type.

Implementations

impl<T> Trace<T>

pub fn new(t: T) -> Self

Creates a new stack-trace wrapping a value.

use debugtrace::Trace;

fn foo() -> Trace<()> {
    Trace::new(())
}

let t = foo();

// Prints "() at:" followed by a backtrace in debug and test profiles
// Will also print the backtrace if the `backtrace` feature is on
// independent of profile
println!("{:?}", t);

pub fn unwrap(self) -> T

Discards the information about where this trace was constructed and yields the wrapped data.

use debugtrace::Trace;

let t = Trace::new("my error");

assert_eq!(t.unwrap(), "my error");

Trait Implementations

impl<T: Clone> Clone for Trace<T>

fn clone(&self) -> Trace<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Trace<T>

Implementation of debug which debug-prints the inner type followed by the stacktrace to the address where the Trace was created.

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

Formats the value using the given formatter.

impl<T> Deref for Trace<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Trace<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T> From<T> for Trace<T>

Enables any error to automatically be wrapped in Trace<E> when Result<T, E> is used in the try! macro.

fn from(t: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Trace<T>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Trace<T>

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Trace<T>

fn eq(&self, rhs: &Trace<T>) -> bool

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

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<T: PartialOrd> PartialOrd for Trace<T>

fn partial_cmp(&self, rhs: &Trace<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for Trace<T>