Struct settings_inspect_utils::managed_inspect_map::ManagedInspectMap

pub struct ManagedInspectMap<V> { /* private fields */ }

A map that wraps an inspect node and attaches all inserted values to the node.

This class can either be explicitly given an inspect node through ManagedInspectMap::with_node or can create its own inspect node when included in a struct that derives Inspect or when [ManagedInspectMap::with_inspect] is called.

Implementations

impl<V> ManagedInspectMap<V>

where for<'a> &'a mut V: Inspect,

pub fn with_node(node: Node) -> Self

Creates a new ManagedInspectMap that attaches inserted values to the given node.

pub fn map(&self) -> &HashMap<String, V>

Returns a reference to the underlying map. Clients should not insert values into the map through this reference.

pub fn map_mut(&mut self) -> &mut HashMap<String, V>

Returns a mutable reference to the underlying map. Clients should not insert values into the map through this reference.

pub fn insert(&mut self, key: String, value: V) -> Option<V>

Inserts the given value into the map and attach it to the inspect tree. Returns the previous value with the given key, if any.

pub fn insert_with_property_name( &mut self, map_key: String, property_name: String, value: V ) -> Option<V>

Inserts the given value into the map and attaches it to the inspect tree with a different name. Returns the previous value with the given map key, if any.

This is useful for cases where the unique key for the map is not useful for actually recording to inspect.

pub fn get_or_insert_with( &mut self, key: String, value: impl FnOnce() -> V ) -> &mut V

Returns a mutable reference to the value at the given key, inserting a value if not present.

pub fn get_mut(&mut self, key: &str) -> Option<&mut V>

Returns a mutable reference to the entry at key.

pub fn get(&self, key: &str) -> Option<&V>

Returns an immutable reference to the entry at key.

pub fn inspect_node(&self) -> &Node

Returns a reference to the inspect node associated with this map.

Trait Implementations

impl<V: Default> Default for ManagedInspectMap<V>

fn default() -> ManagedInspectMap<V>

Returns the “default value” for a type.

impl<V> Inspect for &mut ManagedInspectMap<V>

where for<'a> &'a mut V: Inspect,

fn iattach( self, parent: &Node, name: impl AsRef<str> ) -> Result<(), AttachError>

Attaches self to the inspect tree, under parent[name]. Note that: