Struct iptrie::LCTrieSet

pub struct LCTrieSet<P: IpPrefix>(/* private fields */);

A set of Ip prefixes based on a level-compressed trie

Implementations

impl<P: IpPrefix> LCTrieSet<P>

pub fn len(&self) -> NonZeroUsize

Returns the size of the set.

Notice that it never equals zero since the top prefix is always present in the set.

pub fn info(&self)

pub fn contains<Q>(&self, k: &Q) -> bool

where Q: IpPrefix<Addr = P::Addr>, P: IpPrefixCovering<Q> + PartialEq<Q>,

Checks if an element is present (exact match).

Example

use std::net::Ipv4Addr;

let addr = Ipv4Addr::new(1,1,1,1);

let ip20 = Ipv4Prefix::new(addr, 20).unwrap();
let ip22 = Ipv4Prefix::new(addr, 22).unwrap();
let ip24 = Ipv4Prefix::new(addr, 24).unwrap();

let trie = Ipv4RTrieSet::from_iter([ip20,ip24]);
let lctrie = trie.compress();

assert_eq!( lctrie.contains(&ip20), true);
assert_eq!( lctrie.contains(&ip22), false);
assert_eq!( lctrie.contains(&ip24), true);

pub fn get<Q>(&self, k: &Q) -> Option<&P>

where Q: IpPrefix<Addr = P::Addr>, P: IpPrefixCovering<Q>,

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].

Example

use std::net::Ipv4Addr;
let mut trie = RTrieMap::with_root(42);

let addr = Ipv4Addr::new(1,1,1,1);
let ip20 = Ipv4Prefix::new(addr, 20).unwrap();
let ip22 = Ipv4Prefix::new(addr, 22).unwrap();
let ip24 = Ipv4Prefix::new(addr, 24).unwrap();

trie.insert(ip24, 24);
trie.insert(ip20, 20);

let lctrie = trie.compress();

assert_eq!( lctrie.get(&ip24), Some(&24));
assert_eq!( lctrie.get(&ip22), None);
assert_eq!( lctrie.get(&ip20), Some(&20));

pub fn lookup<Q>(&self, k: &Q) -> &P

where Q: IpPrefix<Addr = P::Addr>, P: IpPrefixCovering<Q>,

Gets the longest prefix which matches the given key.

As the top prefix always matches, it never fails.

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

Example

use std::net::Ipv4Addr;
let mut trie = Ipv4RTrieSet::new();

let addr = Ipv4Addr::new(1,1,1,1);
let ip20 = Ipv4Prefix::new(addr, 20).unwrap();
let ip22 = Ipv4Prefix::new(addr, 22).unwrap();
let ip24 = Ipv4Prefix::new(addr, 24).unwrap();

trie.insert(ip20);
trie.insert(ip24);

let lctrie = trie.compress();

assert_eq!( lctrie.lookup(&ip20), &ip20);
assert_eq!( lctrie.lookup(&ip22), &ip20);
assert_eq!( lctrie.lookup(&ip24), &ip24);

assert_eq!( lctrie.lookup(&addr), &ip24);

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

Iterates over all the prefixes of this set.

Trait Implementations

impl<P: IpRootPrefix> FromIterator<P> for LCTrieSet<P>

fn from_iter<I: IntoIterator<Item = P>>(iter: I) -> Self

Creates a value from an iterator.