1.2.0[−][src]Struct af_lib::fmt::DebugMap
A struct to help with fmt::Debug
implementations.
This is useful when you wish to output a formatted map as a part of your
Debug::fmt
implementation.
This can be constructed by the Formatter::debug_map
method.
Examples
use std::fmt; struct Foo(Vec<(String, i32)>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { fmt.debug_map().entries(self.0.iter().map(|&(ref k, ref v)| (k, v))).finish() } } assert_eq!( format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])), "{\"A\": 10, \"B\": 11}", );
Implementations
impl<'a, 'b> DebugMap<'a, 'b> where
'b: 'a,
[src]
'b: 'a,
pub fn entry(
&mut self,
key: &dyn Debug,
value: &dyn Debug
) -> &mut DebugMap<'a, 'b>
[src]
&mut self,
key: &dyn Debug,
value: &dyn Debug
) -> &mut DebugMap<'a, 'b>
Adds a new entry to the map output.
Examples
use std::fmt; struct Foo(Vec<(String, i32)>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_map() .entry(&"whole", &self.0) // We add the "whole" entry. .finish() } } assert_eq!( format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])), "{\"whole\": [(\"A\", 10), (\"B\", 11)]}", );
pub fn key(&mut self, key: &dyn Debug) -> &mut DebugMap<'a, 'b>
1.42.0[src]
Adds the key part of a new entry to the map output.
This method, together with value
, is an alternative to entry
that
can be used when the complete entry isn't known upfront. Prefer the entry
method when it's possible to use.
Panics
key
must be called before value
and each call to key
must be followed
by a corresponding call to value
. Otherwise this method will panic.
Examples
use std::fmt; struct Foo(Vec<(String, i32)>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_map() .key(&"whole").value(&self.0) // We add the "whole" entry. .finish() } } assert_eq!( format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])), "{\"whole\": [(\"A\", 10), (\"B\", 11)]}", );
pub fn value(&mut self, value: &dyn Debug) -> &mut DebugMap<'a, 'b>
1.42.0[src]
Adds the value part of a new entry to the map output.
This method, together with key
, is an alternative to entry
that
can be used when the complete entry isn't known upfront. Prefer the entry
method when it's possible to use.
Panics
key
must be called before value
and each call to key
must be followed
by a corresponding call to value
. Otherwise this method will panic.
Examples
use std::fmt; struct Foo(Vec<(String, i32)>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_map() .key(&"whole").value(&self.0) // We add the "whole" entry. .finish() } } assert_eq!( format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])), "{\"whole\": [(\"A\", 10), (\"B\", 11)]}", );
pub fn entries<K, V, I>(&mut self, entries: I) -> &mut DebugMap<'a, 'b> where
V: Debug,
I: IntoIterator<Item = (K, V)>,
K: Debug,
[src]
V: Debug,
I: IntoIterator<Item = (K, V)>,
K: Debug,
Adds the contents of an iterator of entries to the map output.
Examples
use std::fmt; struct Foo(Vec<(String, i32)>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_map() // We map our vec so each entries' first field will become // the "key". .entries(self.0.iter().map(|&(ref k, ref v)| (k, v))) .finish() } } assert_eq!( format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])), "{\"A\": 10, \"B\": 11}", );
pub fn finish(&mut self) -> Result<(), Error>
[src]
Finishes output and returns any error encountered.
Panics
key
must be called before value
and each call to key
must be followed
by a corresponding call to value
. Otherwise this method will panic.
Examples
use std::fmt; struct Foo(Vec<(String, i32)>); impl fmt::Debug for Foo { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_map() .entries(self.0.iter().map(|&(ref k, ref v)| (k, v))) .finish() // Ends the struct formatting. } } assert_eq!( format!("{:?}", Foo(vec![("A".to_string(), 10), ("B".to_string(), 11)])), "{\"A\": 10, \"B\": 11}", );
Trait Implementations
impl<'a, 'b> Visit for DebugMap<'a, 'b>
[src]
pub fn record_debug(&mut self, field: &Field, value: &dyn Debug)
[src]
pub fn record_i64(&mut self, field: &Field, value: i64)
[src]
pub fn record_u64(&mut self, field: &Field, value: u64)
[src]
pub fn record_bool(&mut self, field: &Field, value: bool)
[src]
pub fn record_str(&mut self, field: &Field, value: &str)
[src]
pub fn record_error(&mut self, field: &Field, value: &(dyn Error + 'static))
[src]
Auto Trait Implementations
impl<'a, 'b> !RefUnwindSafe for DebugMap<'a, 'b>
[src]
impl<'a, 'b> !Send for DebugMap<'a, 'b>
[src]
impl<'a, 'b> !Sync for DebugMap<'a, 'b>
[src]
impl<'a, 'b> Unpin for DebugMap<'a, 'b> where
'b: 'a,
[src]
'b: 'a,
impl<'a, 'b> !UnwindSafe for DebugMap<'a, 'b>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;
[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;
[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,