Struct UnwindContextWithFmt

pub struct UnwindContextWithFmt<W: Write, T: Debug + DebugAnsiColored, P: PanicDetector> { /* private fields */ }

A structure representing a scoped guard with unwind context with std::io::Write writer.

If dropped during unwind it will write a message to a given writer containing given function or scope context. If created with unwind_context it will write to std::io::Stderr.

When this structure is dropped (falls out of scope) and the current thread is not unwinding, the unwind context will be forgotten.

Examples

use unwind_context::{unwind_context_with_fmt, UnwindContextWithFmt};

fn func(foo: u32, bar: &str, secret: &str, custom_writer: &mut String) {
    let _ctx: UnwindContextWithFmt<_, _, _> = unwind_context_with_fmt!(
        (fn(foo, bar, ...)),
        writer = custom_writer,
        panic_detector = unwind_context::StdPanicDetector,
        color_scheme = None,
    );
    // ...
}

Implementations

impl<W: Write, T: Debug + DebugAnsiColored, P: PanicDetector> UnwindContextWithFmt<W, T, P>

pub fn new( data: T, writer: W, panic_detector: P, color_scheme: Option<&'static AnsiColorScheme>, ) -> Self

Create a new UnwindContextWithFmt with the provided core::fmt::Write writer, context scope data, and color scheme.

This function is not intended to be used directly. Consider using macros like unwind_context_with_fmt instead.

pub fn print(&mut self)

Print context to a writer specified in the UnwindContextWithFmt constructor.

This method is called when a panic detected.

Trait Implementations

impl<W: Clone + Write, T: Clone + Debug + DebugAnsiColored, P: Clone + PanicDetector> Clone for UnwindContextWithFmt<W, T, P>

fn clone(&self) -> UnwindContextWithFmt<W, T, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W: Debug + Write, T: Debug + Debug + DebugAnsiColored, P: Debug + PanicDetector> Debug for UnwindContextWithFmt<W, T, P>

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

Formats the value using the given formatter.

impl<W: Write, T: Debug + DebugAnsiColored, P: PanicDetector> Drop for UnwindContextWithFmt<W, T, P>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: Hash + Write, T: Hash + Debug + DebugAnsiColored, P: Hash + PanicDetector> Hash for UnwindContextWithFmt<W, T, P>

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

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<W: Ord + Write, T: Ord + Debug + DebugAnsiColored, P: Ord + PanicDetector> Ord for UnwindContextWithFmt<W, T, P>

fn cmp(&self, other: &UnwindContextWithFmt<W, T, P>) -> 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<W: PartialEq + Write, T: PartialEq + Debug + DebugAnsiColored, P: PartialEq + PanicDetector> PartialEq for UnwindContextWithFmt<W, T, P>

fn eq(&self, other: &UnwindContextWithFmt<W, T, P>) -> 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<W: PartialOrd + Write, T: PartialOrd + Debug + DebugAnsiColored, P: PartialOrd + PanicDetector> PartialOrd for UnwindContextWithFmt<W, T, P>

fn partial_cmp(&self, other: &UnwindContextWithFmt<W, T, P>) -> 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<W: Eq + Write, T: Eq + Debug + DebugAnsiColored, P: Eq + PanicDetector> Eq for UnwindContextWithFmt<W, T, P>

impl<W: Write, T: Debug + DebugAnsiColored, P: PanicDetector> StructuralPartialEq for UnwindContextWithFmt<W, T, P>