Struct IpRTrieMap 

pub struct IpRTrieMap<V> {
    pub ipv4: Ipv4RTrieMap<V>,
    pub ipv6: Ipv6RTrieMap<V>,
}

A radix trie map that mix both Ipv4 and Ipv6 prefixes

Fields

ipv4: Ipv4RTrieMap<V>

ipv6: Ipv6RTrieMap<V>

Implementations

impl<V: Default> IpRTrieMap<V>

pub fn new() -> Self

impl<V> IpRTrieMap<V>

pub fn with_roots(ipv4: V, ipv6: V) -> Self

impl<V> IpRTrieMap<V>

pub fn len(&self) -> NonZeroUsize

Returns the size of the map.

Notice that it always greater or equals two since two top prefixes are always present in the map (one for Ipv4 and the other for Ipv6)

pub fn compress(self) -> IpLCTrieMap<V>

Compress this Patricia trie in a LC-Trie.

For lookup algorithms, a Patricia trie performs unit bit checking and LC-Trie performs multi bits checking. So the last one is more performant but it cannot be modified (no insertion or removal operations are provided).

pub fn shrink_to_fit(&mut self)

pub fn get(&self, ipnet: &IpNet) -> Option<&V>

Gets the value associated with an exact match of the key.

To access to the longest prefix match, use Self::lookup.

To get a mutable access to a value, use Self::get_mut.

pub fn get_mut(&mut self, ipnet: &IpNet) -> Option<&mut V>

Gets a mutable access to the value associated with an exact match of the key.

To access to the longest prefix match, use Self::lookup_mut.

To get a mutable access to a value, use Self::get_mut.

pub fn lookup(&self, ipnet: &IpNet) -> (IpNet, &V)

Gets the value associated with the longest prefix match of the key.

As the top prefix always matches, the lookup never fails.

To access to the exact prefix match, use Self::get.

To get a mutable access to a value, use Self::lookup_mut.

pub fn lookup_mut(&mut self, ipnet: &IpNet) -> (IpNet, &mut V)

Gets a mutable access to the value associated with a longest prefix match of the key.

To access to the exact prefix match, use Self::get_mut.

pub fn insert(&mut self, ipnet: IpNet, v: V) -> Option<V>

Inserts a new entry in the map.

If the specified key already exists in the map, then the previous associated value is replaced by the new one and is returned.

pub fn remove(&mut self, ipnet: &IpNet) -> Option<V>

Removes a previously inserted prefix (exact match).

Panic

Panics if trying to remove the root prefix.

pub fn iter(&self) -> impl Iterator<Item = (IpNet, &V)> + '_

Iterates over all the entries.

For a mutable access of values, use Self::iter_mut

pub fn iter_mut(&mut self) -> impl Iterator<Item = (IpNet, &mut V)> + '_

Iterates over all the entries with a mutable access to values.

pub fn prefixes(&self) -> IpRTrieSet

Gets a set of copy of all the keys in a trie set.

Trait Implementations

impl<V: Clone> Clone for IpRTrieMap<V>

fn clone(&self) -> IpRTrieMap<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Default> Default for IpRTrieMap<V>

fn default() -> IpRTrieMap<V>

Returns the “default value” for a type.

impl<V> Extend<(IpNet, V)> for IpRTrieMap<V>

fn extend<I: IntoIterator<Item = (IpNet, V)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<V> Extend<(Ipv4Net, V)> for IpRTrieMap<V>

fn extend<I: IntoIterator<Item = (Ipv4Net, V)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<V> Extend<(Ipv6Net, V)> for IpRTrieMap<V>

fn extend<I: IntoIterator<Item = (Ipv6Net, V)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<V: Default> FromIterator<(IpNet, V)> for IpRTrieMap<V>

fn from_iter<I: IntoIterator<Item = (IpNet, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<V: Default> FromIterator<(Ipv4Net, V)> for IpRTrieMap<V>

fn from_iter<I: IntoIterator<Item = (Ipv4Net, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<V: Default> FromIterator<(Ipv6Net, V)> for IpRTrieMap<V>

fn from_iter<I: IntoIterator<Item = (Ipv6Net, V)>>(iter: I) -> Self

Creates a value from an iterator.