Struct debug2::DebugSet

pub struct DebugSet<'a, 'b: 'a> { /* private fields */ }

A struct to help with Debug implementations.

This is useful when you wish to output a formatted set of items as a part of your Debug::fmt implementation.

This can be constructed by the Formatter::debug_set method.

Examples

use debug2::{pprint, Debug, Formatter};
use std::fmt;

struct Foo(Vec<i32>);

impl Debug for Foo {
    fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
        fmt.debug_set().entries(self.0.iter()).finish()
    }
}

assert_eq!(pprint(Foo(vec![10, 11])), "{10, 11}",);

Implementations

impl<'a, 'b: 'a> DebugSet<'a, 'b>

pub fn entry(&mut self, entry: &dyn Debug) -> &mut Self

Adds a new entry to the set output.

Examples

use debug2::{pprint, Debug, Formatter};
use std::fmt;

struct Foo(Vec<i32>, Vec<u32>);

impl Debug for Foo {
    fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
        fmt.debug_set()
            .entry(&self.0) // Adds the first "entry".
            .entry(&self.1) // Adds the second "entry".
            .finish()
    }
}

assert_eq!(
    pprint(Foo(vec![10, 11], vec![12, 13])),
    "{[10, 11], [12, 13]}",
);

pub fn entries<D, I>(&mut self, entries: I) -> &mut Self where
    D: Debug,
    I: IntoIterator<Item = D>, 

Adds the contents of an iterator of entries to the set output.

Examples

use debug2::{pprint, Debug, Formatter};
use std::fmt;

struct Foo(Vec<i32>, Vec<u32>);

impl Debug for Foo {
    fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
        fmt.debug_set()
            .entries(self.0.iter()) // Adds the first "entry".
            .entries(self.1.iter()) // Adds the second "entry".
            .finish()
    }
}

assert_eq!(pprint(Foo(vec![10, 11], vec![12, 13])), "{10, 11, 12, 13}",);

pub fn finish(&mut self) -> Result

Finishes output and returns any error encountered.

Examples

use debug2::{pprint, Debug, Formatter};
use std::fmt;

struct Foo(Vec<i32>);

impl Debug for Foo {
    fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
        fmt.debug_set().entries(self.0.iter()).finish() // Ends the struct formatting.
    }
}

assert_eq!(pprint(Foo(vec![10, 11])), "{10, 11}",);