Struct OccupiedEntry 

pub struct OccupiedEntry<'a, P, T> { /* private fields */ }

A mutable view into an occupied entry. An occupied entry represents a node that is already present on the tree.

Implementations

impl<P: Prefix, T> OccupiedEntry<'_, P, T>

pub fn key(&self) -> &P

Gets a reference to the key in the entry. This is the key that is currently stored, and not the key that was used in the insert.

use prefix_trie::map::Entry;
let mut pm: PrefixMap<ipnet::Ipv4Net, _> = PrefixMap::new();
pm.insert("192.168.1.0/24".parse()?, 1);
match pm.entry("192.168.1.1/24".parse()?) {
    Entry::Occupied(e) => assert_eq!(e.key(), &"192.168.1.0/24".parse()?),
    Entry::Vacant(_) => unreachable!(),
}

pub fn get(&self) -> &T

Gets a reference to the value in the entry.

use prefix_trie::map::Entry;

let mut pm: PrefixMap<ipnet::Ipv4Net, _> = PrefixMap::new();
pm.insert("192.168.1.0/24".parse()?, 1);
match pm.entry("192.168.1.0/24".parse()?) {
    Entry::Occupied(e) => assert_eq!(e.get(), &1),
    Entry::Vacant(_) => unreachable!(),
}

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the value in the entry.

Prefixes are not stored verbatim. They are reconstructed from the trie position, so host bits masked out by the prefix length are not preserved.

use prefix_trie::map::Entry;

let mut pm: PrefixMap<ipnet::Ipv4Net, _> = PrefixMap::new();
pm.insert("192.168.1.0/24".parse()?, 1);
match pm.entry("192.168.1.0/24".parse()?) {
    Entry::Occupied(mut e) => *e.get_mut() += 1,
    Entry::Vacant(_) => unreachable!(),
}
assert_eq!(pm.get(&"192.168.1.0/24".parse()?), Some(&2));

pub fn insert(self, v: T) -> T

Insert a new value into the entry, returning the old value.

use prefix_trie::map::Entry;

let mut pm: PrefixMap<ipnet::Ipv4Net, _> = PrefixMap::new();
pm.insert("192.168.1.0/24".parse()?, 1);
match pm.entry("192.168.1.0/24".parse()?) {
    Entry::Occupied(mut e) => assert_eq!(e.insert(10), 1),
    Entry::Vacant(_) => unreachable!(),
}
assert_eq!(pm.get(&"192.168.1.0/24".parse()?), Some(&10));

pub fn remove(self) -> T

Remove the current value and return it. Empty trie nodes may be left in place (the same effect as PrefixMap::remove_keep_tree).

use prefix_trie::map::Entry;

let mut pm: PrefixMap<ipnet::Ipv4Net, i32> = PrefixMap::new();
pm.insert("192.168.1.0/24".parse()?, 1);
match pm.entry("192.168.1.0/24".parse()?) {
    Entry::Occupied(mut e) => assert_eq!(e.remove(), 1),
    Entry::Vacant(_) => unreachable!(),
}
assert_eq!(pm.get(&"192.168.1.0/24".parse()?), None);

impl<'a, P, T> OccupiedEntry<'a, P, T>

pub fn into_mut(self) -> &'a mut T

Converts this occupied entry into a mutable reference to the stored value.