Struct std::fmt::DebugSet 1.2.0[−][src]
#[must_use = "must eventually call `finish()` on Debug builders"]pub struct DebugSet<'a, 'b> where
'b: 'a, { /* fields omitted */ }
A struct to help with fmt::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 std::fmt; struct Foo(Vec<i32>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.debug_set().entries(self.0.iter()).finish() } } assert_eq!( format!("{:?}", Foo(vec![10, 11])), "{10, 11}", );Run
Implementations
impl<'a, 'b> DebugSet<'a, 'b> where
'b: 'a,
[src]
impl<'a, 'b> DebugSet<'a, 'b> where
'b: 'a,
[src]pub fn entry(&mut self, entry: &dyn Debug) -> &mut DebugSet<'a, 'b>
[src]
Adds a new entry to the set output.
Examples
use std::fmt; struct Foo(Vec<i32>, Vec<u32>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_set() .entry(&self.0) // Adds the first "entry". .entry(&self.1) // Adds the second "entry". .finish() } } assert_eq!( format!("{:?}", Foo(vec![10, 11], vec![12, 13])), "{[10, 11], [12, 13]}", );Run
pub fn entries<D, I>(&mut self, entries: I) -> &mut DebugSet<'a, 'b> where
I: IntoIterator<Item = D>,
D: Debug,
[src]
I: IntoIterator<Item = D>,
D: Debug,
Adds the contents of an iterator of entries to the set output.
Examples
use std::fmt; struct Foo(Vec<i32>, Vec<u32>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::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!( format!("{:?}", Foo(vec![10, 11], vec![12, 13])), "{10, 11, 12, 13}", );Run
pub fn finish(&mut self) -> Result<(), Error>
[src]
Finishes output and returns any error encountered.
Examples
use std::fmt; struct Foo(Vec<i32>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_set() .entries(self.0.iter()) .finish() // Ends the struct formatting. } } assert_eq!( format!("{:?}", Foo(vec![10, 11])), "{10, 11}", );Run
Auto Trait Implementations
impl<'a, 'b> !RefUnwindSafe for DebugSet<'a, 'b>
impl<'a, 'b> !Send for DebugSet<'a, 'b>
impl<'a, 'b> !Sync for DebugSet<'a, 'b>
impl<'a, 'b> Unpin for DebugSet<'a, 'b> where
'b: 'a,
'b: 'a,
impl<'a, 'b> !UnwindSafe for DebugSet<'a, 'b>
Blanket Implementations
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut I
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W
[src]
Notable traits for &'_ mut I
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut I
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W
[src]
Notable traits for &'_ mut I
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized> Read for &mut Rimpl<W: Write + ?Sized> Write for &mut W