Struct ockam_core::lib::fmt::DebugStruct 1.2.0[−][src]
#[must_use = "must eventually call `finish()` on Debug builders"]pub struct DebugStruct<'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 struct as a part of your
Debug::fmt
implementation.
This can be constructed by the Formatter::debug_struct
method.
Examples
use std::fmt; struct Foo { bar: i32, baz: String, } impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.debug_struct("Foo") .field("bar", &self.bar) .field("baz", &self.baz) .finish() } } assert_eq!( format!("{:?}", Foo { bar: 10, baz: "Hello World".to_string() }), "Foo { bar: 10, baz: \"Hello World\" }", );
Implementations
impl<'a, 'b> DebugStruct<'a, 'b> where
'b: 'a,
[src]
impl<'a, 'b> DebugStruct<'a, 'b> where
'b: 'a,
[src]pub fn field(
&mut self,
name: &str,
value: &dyn Debug
) -> &mut DebugStruct<'a, 'b>
[src]
&mut self,
name: &str,
value: &dyn Debug
) -> &mut DebugStruct<'a, 'b>
Adds a new field to the generated struct output.
Examples
use std::fmt; struct Bar { bar: i32, another: String, } impl fmt::Debug for Bar { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_struct("Bar") .field("bar", &self.bar) // We add `bar` field. .field("another", &self.another) // We add `another` field. // We even add a field which doesn't exist (because why not?). .field("not_existing_field", &1) .finish() // We're good to go! } } assert_eq!( format!("{:?}", Bar { bar: 10, another: "Hello World".to_string() }), "Bar { bar: 10, another: \"Hello World\", not_existing_field: 1 }", );
pub fn finish_non_exhaustive(&mut self) -> Result<(), Error>
1.53.0[src]
Marks the struct as non-exhaustive, indicating to the reader that there are some other fields that are not shown in the debug representation.
Examples
use std::fmt; struct Bar { bar: i32, hidden: f32, } impl fmt::Debug for Bar { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_struct("Bar") .field("bar", &self.bar) .finish_non_exhaustive() // Show that some other field(s) exist. } } assert_eq!( format!("{:?}", Bar { bar: 10, hidden: 1.0 }), "Bar { bar: 10, .. }", );
pub fn finish(&mut self) -> Result<(), Error>
[src]
Finishes output and returns any error encountered.
Examples
use std::fmt; struct Bar { bar: i32, baz: String, } impl fmt::Debug for Bar { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_struct("Bar") .field("bar", &self.bar) .field("baz", &self.baz) .finish() // You need to call it to "finish" the // struct formatting. } } assert_eq!( format!("{:?}", Bar { bar: 10, baz: "Hello World".to_string() }), "Bar { bar: 10, baz: \"Hello World\" }", );
Auto Trait Implementations
impl<'a, 'b> !RefUnwindSafe for DebugStruct<'a, 'b>
impl<'a, 'b> !RefUnwindSafe for DebugStruct<'a, 'b>
impl<'a, 'b> !Send for DebugStruct<'a, 'b>
impl<'a, 'b> !Send for DebugStruct<'a, 'b>
impl<'a, 'b> !Sync for DebugStruct<'a, 'b>
impl<'a, 'b> !Sync for DebugStruct<'a, 'b>
impl<'a, 'b> Unpin for DebugStruct<'a, 'b> where
'b: 'a,
impl<'a, 'b> Unpin for DebugStruct<'a, 'b> where
'b: 'a,
impl<'a, 'b> !UnwindSafe for DebugStruct<'a, 'b>
impl<'a, 'b> !UnwindSafe for DebugStruct<'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 for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized,
[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 for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized,
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 for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized,
[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 for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,