pub struct DebugList<'a, 'b: 'a> { /* private fields */ }
Expand description
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
sourceimpl<'a, 'b: 'a> DebugList<'a, 'b>
impl<'a, 'b: 'a> DebugList<'a, 'b>
sourcepub fn entry(&mut self, entry: &dyn Debug) -> &mut Self
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]]",
);
sourcepub fn entries<D, I>(&mut self, entries: I) -> &mut Self where
D: Debug,
I: IntoIterator<Item = D>,
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]",);
sourcepub fn finish(&mut self) -> Result
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]",);
Auto Trait Implementations
impl<'a, 'b> !RefUnwindSafe for DebugList<'a, 'b>
impl<'a, 'b> !Send for DebugList<'a, 'b>
impl<'a, 'b> !Sync for DebugList<'a, 'b>
impl<'a, 'b> Unpin for DebugList<'a, 'b> where
'b: 'a,
impl<'a, 'b> !UnwindSafe for DebugList<'a, 'b>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more