pub struct DebugStruct<'f, 'w> { /* private fields */ }
Available on crate feature fmt only.
Expand description

A helper struct for debug formatting a braced struct, or braced variant.

Example

This example demonstrates how you can debug format a struct, and a braced variant.

#![feature(const_mut_refs)]

use const_format::{Error, Formatter};
use const_format::{call_debug_fmt, coerce_to_fmt, formatc, impl_fmt, try_};

fn main() {
    const STRUC: &str = formatc!("{:?}", Foo { a: 5, b: [8, 13, 21], c: "34" });
    const ENUM_: &str = formatc!("{:?}", Bar::Baz { d: false, e: None });
     
    assert_eq!(STRUC, "Foo { a: 5, b: [8, 13, 21], c: \"34\" }");
    assert_eq!(ENUM_, "Baz { d: false, e: None }");
}

struct Foo{
    a: u32,
    b: [u32; 3],
    c: &'static str,
}

enum Bar {
    Baz{
        d: bool,
        e: Option<bool>,
    }
}

impl_fmt!{
    impl Foo;
     
    const fn const_debug_fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
        let mut f = f.debug_struct("Foo");
        try_!(coerce_to_fmt!(&self.a).const_debug_fmt(f.field("a")));
        try_!(coerce_to_fmt!(&self.b).const_debug_fmt(f.field("b")));
        try_!(coerce_to_fmt!(&self.c).const_debug_fmt(f.field("c")));
        f.finish()
    }
}

impl_fmt!{
    impl Bar;
     
    const fn const_debug_fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
        match self {
            Bar::Baz{d, e} => {
                let mut f = f.debug_struct("Baz");
                 
                // This macro allows debug formatting some generic types that
                // don't have a const_debug_fmt fn, like Options which wrap non-std types.
                call_debug_fmt!(std, d, f.field("d"));
                call_debug_fmt!(Option, e, f.field("e"));
                 
                f.finish()
            }
        }
    }
}


Implementations§

source§

impl<'f, 'w> DebugStruct<'f, 'w>

source

pub const fn field(&mut self, name: &str) -> &mut Formatter<'w>

Adds a field to the formatted output.

source

pub const fn finish(self) -> Result<(), Error>

Finishes writing the struct/variant, and if anything went wrong in the field method,returns an error.

Auto Trait Implementations§

§

impl<'f, 'w> RefUnwindSafe for DebugStruct<'f, 'w>

§

impl<'f, 'w> Send for DebugStruct<'f, 'w>

§

impl<'f, 'w> Sync for DebugStruct<'f, 'w>

§

impl<'f, 'w> Unpin for DebugStruct<'f, 'w>

§

impl<'f, 'w> !UnwindSafe for DebugStruct<'f, 'w>

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, 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.