Struct inspect::Iterated

pub struct Iterated<I>(/* private fields */);

Implementation of Inspect a type that implements Iterator with an item type (K, V).

Inspecting this type will respond with a field for each entry in the iterator, with K for the field’s name and V for the field’s value.

Construct with iter_by_key or iter_by_index.

Implementations

impl<I, K, V> Iterated<I>

where I: Clone + Iterator<Item = (K, V)>,

pub fn map_key<F, K2>( self, f: F, ) -> Iterated<impl Clone + Iterator<Item = (K2, V)>>

where F: Clone + FnMut(K) -> K2,

Maps the key of the iterator with f.

Example

fn inspect(req: inspect::Request<'_>) {
    let v = vec!["foo", "bar", "baz"];
    // Responds with { 1: "foo", 2: "bar", 3: "baz" }.
    req.respond().field("v", inspect::iter_by_index(&v).map_key(|k| k + 1));
}

pub fn map_value<F, V2>( self, f: F, ) -> Iterated<impl Clone + Iterator<Item = (K, V2)>>

where F: Clone + FnMut(V) -> V2,

Maps the value of the iterator with f.

Example

fn inspect(req: inspect::Request<'_>) {
    let v = vec![10, 20, 30];
    // Responds with { 0: 20, 1: 40, 2: 60 }.
    req.respond().field("v", inspect::iter_by_index(&v).map_value(|v| v * 2));
}

pub fn prefix<'a>( self, prefix: &'a str, ) -> Iterated<impl 'a + Clone + Iterator<Item = (String, V)>>

where K: Display + 'a, I: 'a, V: 'a,

Prefixes each key with the string prefix.

Example

fn inspect(req: inspect::Request<'_>) {
    let v = vec![10, 20, 30];
    // Responds with { n0: 10, n1: 20, n2: 30 }.
    req.respond().field("v", inspect::iter_by_index(&v).prefix("n"));
}

Trait Implementations

impl<I: Default> Default for Iterated<I>

fn default() -> Iterated<I>

Returns the “default value” for a type.

impl<I, K, V> Inspect for Iterated<I>

where I: Clone + Iterator<Item = (K, V)>, K: ToString, V: Inspect,

fn inspect(&self, req: Request<'_>)

Inspects the object.