Struct dbg_pls::DebugMap

pub struct DebugMap<'a> { /* private fields */ }

A helper designed to assist with creation of DebugPls implementations for maps.

Examples

use dbg_pls::{pretty, DebugPls, Formatter};
use std::collections::BTreeMap;

struct Foo(BTreeMap<String, i32>);

impl DebugPls for Foo {
    fn fmt(&self, f: Formatter) {
        f.debug_map().entries(&self.0).finish()
    }
}
let mut value = Foo(BTreeMap::from([
    ("Hello".to_string(), 5),
    ("World".to_string(), 10),
]));
assert_eq!(
    format!("{}", pretty(&value)),
"{
    [\"Hello\"] = 5;
    [\"World\"] = 10;
}",
);

Implementations

impl<'a> DebugMap<'a>

pub fn key(self, key: &dyn DebugPls) -> Self

Adds the key part to the map output.

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.

pub fn value(self, value: &dyn DebugPls) -> Self

Adds the value part to the map output.

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.

pub fn entry(self, key: &dyn DebugPls, value: &dyn DebugPls) -> Self

Adds the entry to the map output.

pub fn entries<K, V, I>(self, entries: I) -> Self where
    K: DebugPls,
    V: DebugPls,
    I: IntoIterator<Item = (K, V)>, 

Adds all the entries to the map output.

pub fn finish(self)

Closes off the map.