Struct Map

pub struct Map<K, V>
where
    K: BitString + Clone,
    V: Default + Clone + Eq,
{ /* private fields */ }

Map of bit strings (combined to prefixes) to values

Each bit string can only have a single value; sibling bit strings mapping to the same value are automatically merged internally.

This is implemented as a crate::tree::Tree where only leaf nodes carry values.

Implementations

impl<K, V> Map<K, V>

where K: BitString + Clone, V: Default + Clone + Eq,

pub const fn new() -> Self

New (empty) map.

pub fn insert(&mut self, prefix: K, value: V)

Set new value for all bit strings with given prefix

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

Unset values for all bit strings with given prefix

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

Lookup value for a bit string

If only a prefix for longer values is given this only finds an aggregated value, i.e. lookups should usually be done using a “full-length” bit string. (E.g. lookup single hosts in a CIDR-map.)

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

pub fn iter_full(&self) -> IterMapFull<'_, K, V>

Iterate over smallest list of bit strings that cover everything with a value or None if not mapped

Trait Implementations

impl<K, V> Clone for Map<K, V>

where K: BitString + Clone + Clone, V: Default + Clone + Eq + Clone,

fn clone(&self) -> Map<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 Map<K, V>

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

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

Formats the value using the given formatter.

impl<K, V> Default for Map<K, V>

where K: BitString + Clone, V: Default + Clone + Eq,

fn default() -> Self

Returns the “default value” for a type.