Struct FullMap

pub struct FullMap<K: BitString + Clone, V> { /* private fields */ }

Map bit string prefixes to values

This allows overriding values based on “better matching” longer prefixes in an efficient way.

Network routing tables are usually implemented that way: there often is a default route for 0.0.0.0/0 and then a “more specific” for the LAN, e.g. 192.168.0.0/24. (I.e. a route is a map entry for a prefix to a “nexthop specification”, as in how to forward a packet matching the entry. The “most specific” (longest) matching route is used.)

This is implemented as a crate::tree::Tree where all nodes can have an optional value; branches where no node has a value are pruned.

Implementations

impl<K, V> FullMap<K, V>

where K: BitString + Clone,

pub const fn new() -> Self

New (empty) map.

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

Gets the given key’s corresponding entry in the map for in-place manipulation.

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

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned.

pub fn remove(&mut self, key: &K) -> Option<V>

Removes a key from the map, returning the stored key and value if the key was previously in the map.

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

Returns a reference to the value corresponding to the key.

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

Returns a mutable reference to the value corresponding to the key.

pub fn most_specific(&self, key: &K) -> Option<(&K, &V)>

Returns a reference to the key-value pair for the longest prefix of the key in the map.

pub fn remove_tree(&mut self, key: K)

Remove all prefixes equal or longer than given key

pub fn path(&self, key: K) -> IterPath<'_, K, V>

Iterate over all prefixes and their values on the path to a key

pub fn path_mut(&mut self, key: K) -> IterPathMut<'_, K, V>

Iterate over all prefixes and their mutable values on the path to a key

pub fn iter(&self) -> IterMap<'_, K, V>

Iterate over all (aggregated) prefixes and their values

pub fn iter_mut(&mut self) -> IterMutMap<'_, K, V>

Iterate over all (aggregated) prefixes and their mutable values

Trait Implementations

impl<K: Clone + BitString + Clone, V: Clone> Clone for FullMap<K, V>

fn clone(&self) -> FullMap<K, V>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K, V> Debug for FullMap<K, V>

where K: BitString + Clone + Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K: BitString + Clone, V> Default for FullMap<K, V>

fn default() -> Self

Returns the “default value” for a type.