Struct PrefixMap

Source

pub struct PrefixMap<K, V> { /* private fields */ }

Expand description

A map implemented with prefix tree.

Implementations§

Source §

impl<K: Eq + Clone, V> PrefixMap<K, V>

Source

pub fn new() -> PrefixMap<K, V>

Creates an empty PrefixMap.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();

Source

pub fn contains_key<Q>(&self, key: Q) -> bool
where Q: AsRef<[K]>,

Returns true if the map contains a value for the specified key.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
map.insert("foo", 1);
assert_eq!(map.contains_key("foo"), true);
assert_eq!(map.contains_key("bar"), false);

Source

pub fn clear(&mut self)

Clears the map, removing all key-value pairs.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
map.insert("foo", 1);
map.clear();
assert!(map.is_empty());

Source

pub fn get<Q>(&self, key: Q) -> Option<&V>
where Q: AsRef<[K]>,

Returns a reference to the value corresponding to the key.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
map.insert("foo", 1);
assert_eq!(map.get("foo"), Some(&1));
assert_eq!(map.get("bar"), None);

Source

pub fn get_mut<Q>(&mut self, key: Q) -> Option<&mut V>
where Q: AsRef<[K]>,

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

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
map.insert("foo", 1);
if let Some(x) = map.get_mut("foo") {
    *x = 2;
}
assert_eq!(map.get("foo"), Some(&2));

Source

pub fn insert<Q>(&mut self, key: Q, value: V) -> Option<V>
where Q: AsRef<[K]>,

Inserts a key-value pair into the map.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
assert_eq!(map.insert("a", 42), None);
assert_eq!(map.is_empty(), false);
assert_eq!(map.insert("a", 5), Some(42));
assert_eq!(map.get("a"), Some(&5));

Source

pub fn remove<Q>(&mut self, key: Q) -> Option<V>
where Q: AsRef<[K]>,

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

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
assert_eq!(map.insert("a", 42), None);
assert_eq!(map.remove("a"), Some(42));
assert_eq!(map.get("a"), None);

Source

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
assert_eq!(map.is_empty(), true);
map.insert("foo", 1);
assert_eq!(map.is_empty(), false);

Source

pub fn len(&self) -> usize

Returns the number of elements in the map.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
assert_eq!(map.len(), 0);
map.insert("foo", 1);
assert_eq!(map.len(), 1);

Source

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

Gets an iterator over the entries of the map, in arbitrary order.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<u8, i32> = PrefixMap::new();
map.insert("1", 9);
map.insert("2", 8);
map.insert("3", 7);

for (key, value) in map.iter() {
    println!("{:?}: {:?}", key, value);
}

Source

pub fn keys(&self) -> Keys<'_, K, V>

Gets an iterator over the keys of the map, in arbitrary order.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<i32, i32> = PrefixMap::new();
map.insert([1], 2);
map.insert([2], 3);

assert_eq!(map.keys().collect::<Vec<_>>(), vec![vec![1], vec![2]]);

Source

pub fn values(&self) -> Values<'_, K, V>

Gets an iterator over the values of the map, in arbitrary order.

§Examples

use prefix_tree::PrefixMap;

let mut map: PrefixMap<i32, i32> = PrefixMap::new();
map.insert([1], 2);
map.insert([2], 3);

assert_eq!(map.values().cloned().collect::<Vec<_>>(), vec![2, 3]);