Struct netstack3_base::socketmap::SocketMap

pub struct SocketMap<A: Hash + Eq, V: Tagged<A>> { /* private fields */ }

A map that stores values and summarizes tag counts.

This provides a similar insertion/removal API to HashMap for individual key/value pairs. Unlike a regular HashMap, the key type A is required to implement IterShadows, and V to implement Tagged.

Since A implements IterShadows, a given value a : A has zero or more shadow values. Since the shadow relationship is transitive, we call any value v that is reachable by following shadows of a one of a’s “ancestors”, and we say a is a “descendant” of v.

In addition to keys and values, this map stores the number of values present in the map for all descendants of each key. These counts are separated into buckets for different tags of type V::Tag.

Implementations

impl<A, V> SocketMap<A, V>

where A: IterShadows + Hash + Eq, V: Tagged<A>,

pub fn len(&self) -> usize

Returns the number of entries in this SocketMap.

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

Gets a reference to the value associated with the given key, if any.

pub fn entry(&mut self, key: A) -> Entry<'_, A, V>

Provides an Entry for the given key for in-place manipulation.

This is similar to the API provided by HashMap::entry. Callers can match on the result to perform different actions depending on whether the map has a value for the key or not.

pub fn descendant_counts( &self, key: &A, ) -> impl ExactSizeIterator<Item = &(V::Tag, NonZeroUsize)>

Returns counts of tags for values at keys that shadow key.

This is equivalent to iterating over all keys in the map, filtering for those keys for which key is one of their shadows, then calling Tagged::tag on the value for each of those keys, and then computing the number of occurrences for each tag.

pub fn iter(&self) -> impl Iterator<Item = (&A, &V)>

Returns an iterator over the keys and values in the map.

Trait Implementations

impl<A: Debug + Hash + Eq, V: Debug + Tagged<A>> Debug for SocketMap<A, V>

where V::Tag: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<A: Hash + Eq, V: Tagged<A>> Default for SocketMap<A, V>

fn default() -> Self

Returns the “default value” for a type.