Trait DebugExt 

pub trait DebugExt {
    type Ctx;

    // Required method
    fn fmt_with(&self, f: &mut Formatter<'_>, ctx: &Self::Ctx) -> FmtResult<()>;

    // Provided method
    fn debug_with<'a>(&'a self, ctx: &'a Self::Ctx) -> DebugWith<'a, Self>
       where Self: Sized { ... }
}

🖹 🐛 Extension for contextual debugging.

---

^{📍 text/fmt}

---

Types implementing this trait support formatting with a caller-supplied context. The context is defined per-type via the Ctx associated type, allowing each type to expose whatever formatting modes it needs without affecting other types.

Examples

enum Mode { Hex, Dec }
struct Value(u32);
impl DebugExt for Value {
    type Ctx = Mode;
    fn fmt_with(&self, f: &mut Formatter, mode: &Self::Ctx) -> FmtResult<()> {
        match mode {
            Mode::Hex => write!(f, "0x{:X}", self.0),
            Mode::Dec => write!(f, "{}", self.0),
        }
    }
}
let v = Value(255);
// caller chooses representation:
// v.fmt_with(f, &Mode::Hex) → "0xFF"
// v.fmt_with(f, &Mode::Dec) → "255"

Required Associated Types

type Ctx

The context used to guide formatting.

Required Methods

fn fmt_with(&self, f: &mut Formatter<'_>, ctx: &Self::Ctx) -> FmtResult<()>

Formats self under the given context.

Provided Methods

fn debug_with<'a>(&'a self, ctx: &'a Self::Ctx) -> DebugWith<'a, Self>

where Self: Sized,

Wraps self for contextual debug formatting.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl DebugExt for AppControlSet

where AppControlSet: Debug,

type Ctx = ReprMode

impl DebugExt for AsciiSet

where AsciiSet: Debug,

type Ctx = ReprMode

impl DebugExt for BitfieldExample

where BitfieldExample: Debug,

Available on crate features _docs_examples only.

type Ctx = ReprMode

impl DebugExt for EnumSetExample

where EnumSetExample: Debug,

Available on doc or test only.

type Ctx = ReprMode

impl DebugExt for EventButtons

where EventButtons: Debug,

Available on crate feature event only.

type Ctx = ReprMode

impl DebugExt for EventTagSet

where EventTagSet: Debug,

Available on crate feature event only.

type Ctx = ReprMode

impl DebugExt for EventTimestamp

Available on crate feature event only.

type Ctx = EventTimestampMode

impl DebugExt for KeyMods

where KeyMods: Debug,

Available on crate feature event only.

type Ctx = ReprMode

impl DebugExt for LinuxSigactionFlags

where LinuxSigactionFlags: Debug,

Available on crate feature linux only.

type Ctx = ReprMode

impl DebugExt for LinuxSignalSet

where LinuxSignalSet: Debug,

Available on crate feature linux only.

type Ctx = ReprMode

impl DebugExt for LinuxTermiosControlFlags

where LinuxTermiosControlFlags: Debug,

Available on crate feature linux only.

type Ctx = ReprMode

impl DebugExt for LinuxTermiosInputFlags

where LinuxTermiosInputFlags: Debug,

Available on crate feature linux only.

type Ctx = ReprMode

impl DebugExt for LinuxTermiosLocalFlags

where LinuxTermiosLocalFlags: Debug,

Available on crate feature linux only.

type Ctx = ReprMode

impl DebugExt for LinuxTermiosOutputFlags

where LinuxTermiosOutputFlags: Debug,

Available on crate feature linux only.

type Ctx = ReprMode

impl DebugExt for RandQualities

where RandQualities: Debug,

type Ctx = ReprMode

impl DebugExt for RunCapInput

where RunCapInput: Debug,

type Ctx = ReprMode

impl DebugExt for RunCapSystem

where RunCapSystem: Debug,

type Ctx = ReprMode

impl DebugExt for RunCapText

where RunCapText: Debug,

type Ctx = ReprMode

impl DebugExt for TermCaps

where TermCaps: Debug,

Available on crate feature term only.

type Ctx = ReprMode

impl DebugExt for TermColor

where TermColor: Debug,

Available on crate feature term only.

type Ctx = ReprMode

impl DebugExt for TermMode

where TermMode: Debug,

Available on crate feature term only.

type Ctx = ReprMode

impl DebugExt for TermStyle

where TermStyle: Debug,

Available on crate feature term only.

type Ctx = ReprMode

impl DebugExt for TermStyleExt

where TermStyleExt: Debug,

Available on crate feature term only.

type Ctx = ReprMode

impl DebugExt for TermelMeta

where TermelMeta: Debug,

Available on crate feature term only.

type Ctx = ReprMode