Struct debug2::DebugList

pub struct DebugList<'a, 'b: 'a> { /* fields omitted */ }

A struct to help with Debug implementations.

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

This can be constructed by the Formatter::debug_list 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_list().entries(self.0.iter()).finish()
    }
}

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

Implementations

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

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

Adds a new entry to the list 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_list()
            .entry(&self.0) // We add the first "entry".
            .entry(&self.1) // We add 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 list 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_list()
            .entries(self.0.iter())
            .entries(self.1.iter())
            .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_list().entries(self.0.iter()).finish() // Ends the struct formatting.
    }
}

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