Struct patricia_tree::map::PatriciaMap

pub struct PatriciaMap<V> { /* fields omitted */ }

A map based on a patricia tree.

Methods

impl<V> PatriciaMap<V>

pub fn new() -> Self

Makes a new empty PatriciaMap instance.

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
assert!(map.is_empty());

map.insert("foo", 10);
assert_eq!(map.len(), 1);
assert_eq!(map.get("foo"), Some(&10));

map.remove("foo");
assert_eq!(map.get("foo"), None);

pub fn clear(&mut self)

Clears this map, removing all values.

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
map.insert("foo", 1);
map.clear();
assert!(map.is_empty());

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

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

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
map.insert("foo", 1);
assert!(map.contains_key("foo"));
assert!(!map.contains_key("bar"));

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

Returns a reference to the value corresponding to the key.

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
map.insert("foo", 1);
assert_eq!(map.get("foo"), Some(&1));
assert_eq!(map.get("bar"), None);

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

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

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
map.insert("foo", 1);
map.get_mut("foo").map(|v| *v = 2);
assert_eq!(map.get("foo"), Some(&2));

pub fn get_longest_common_prefix<'a, K: ?Sized>(
    &self,
    key: &'a K
) -> Option<(&'a [u8], &V)> where
    K: AsRef<[u8]>, 

Finds the longest common prefix of key and the keys in this map, and returns a reference to the entry whose key matches the prefix.

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
map.insert("foo", 1);
map.insert("foobar", 2);
assert_eq!(map.get_longest_common_prefix("fo"), None);
assert_eq!(map.get_longest_common_prefix("foo"), Some(("foo".as_bytes(), &1)));
assert_eq!(map.get_longest_common_prefix("fooba"), Some(("foo".as_bytes(), &1)));
assert_eq!(map.get_longest_common_prefix("foobar"), Some(("foobar".as_bytes(), &2)));
assert_eq!(map.get_longest_common_prefix("foobarbaz"), Some(("foobar".as_bytes(), &2)));

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

Inserts a key-value pair into this map.

If the map did not have this key present, None is returned. If the map did have this key present, the value is updated, and the old value is returned.

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
assert_eq!(map.insert("foo", 1), None);
assert_eq!(map.get("foo"), Some(&1));
assert_eq!(map.insert("foo", 2), Some(1));
assert_eq!(map.get("foo"), Some(&2));

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

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

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
map.insert("foo", 1);
assert_eq!(map.remove("foo"), Some(1));
assert_eq!(map.remove("foo"), None);

pub fn split_by_prefix<K: AsRef<[u8]>>(&mut self, prefix: K) -> Self

Splits the map into two at the given prefix.

The returned map contains all the entries of which keys are prefixed by prefix.

Examples

use patricia_tree::PatriciaMap;

let mut a = PatriciaMap::new();
a.insert("rust", 1);
a.insert("ruby", 2);
a.insert("bash", 3);
a.insert("erlang", 4);
a.insert("elixir", 5);

let b = a.split_by_prefix("e");
assert_eq!(a.len(), 3);
assert_eq!(b.len(), 2);

assert_eq!(a.keys().collect::<Vec<_>>(), [b"bash", b"ruby", b"rust"]);
assert_eq!(b.keys().collect::<Vec<_>>(), [b"elixir", b"erlang"]);

pub fn len(&self) -> usize

Returns the number of elements in this map.

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
map.insert("foo", 1);
map.insert("bar", 2);
assert_eq!(map.len(), 2);

pub fn is_empty(&self) -> bool

Returns true if this map contains no elements.

Examples

use patricia_tree::PatriciaMap;

let mut map = PatriciaMap::new();
assert!(map.is_empty());

map.insert("foo", 1);
assert!(!map.is_empty());

map.clear();
assert!(map.is_empty());

Important traits for Iter<'a, V>

impl<'a, V: 'a> Iterator for Iter<'a, V> type Item = (Vec<u8>, &'a V);

pub fn iter(&self) -> Iter<V>

Gets an iterator over the entries of this map, sorted by key.

Examples

use patricia_tree::PatriciaMap;

let map: PatriciaMap<_> =
    vec![("foo", 1), ("bar", 2), ("baz", 3)].into_iter().collect();
assert_eq!(vec![(Vec::from("bar"), &2), ("baz".into(), &3), ("foo".into(), &1)],
           map.iter().collect::<Vec<_>>());

Important traits for IterMut<'a, V>

impl<'a, V: 'a> Iterator for IterMut<'a, V> type Item = (Vec<u8>, &'a mut V);

pub fn iter_mut(&mut self) -> IterMut<V>

Gets a mutable iterator over the entries of this map, soretd by key.

Examples

use patricia_tree::PatriciaMap;

let mut map: PatriciaMap<_> =
    vec![("foo", 1), ("bar", 2), ("baz", 3)].into_iter().collect();
for (_, v) in map.iter_mut() {
   *v += 10;
}
assert_eq!(map.get("bar"), Some(&12));

pub fn iter_prefix<'a, 'b>(
    &'a self,
    prefix: &'b [u8]
) -> impl 'a + Iterator<Item = (Vec<u8>, &'a V)> where
    'b: 'a, 

Gets an iterator over the entries having the given prefix of this map, sorted by key.

Examples

use patricia_tree::PatriciaMap;

let map: PatriciaMap<_> =
    vec![("foo", 1), ("bar", 2), ("baz", 3)].into_iter().collect();
assert_eq!(vec![(Vec::from("bar"), &2), ("baz".into(), &3)],
           map.iter_prefix(b"ba").collect::<Vec<_>>());

Important traits for Keys<'a, V>

impl<'a, V: 'a> Iterator for Keys<'a, V> type Item = Vec<u8>;

pub fn keys(&self) -> Keys<V>

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

Examples

use patricia_tree::PatriciaMap;

let map: PatriciaMap<_> =
    vec![("foo", 1), ("bar", 2), ("baz", 3)].into_iter().collect();
assert_eq!(vec![Vec::from("bar"), "baz".into(), "foo".into()],
           map.keys().collect::<Vec<_>>());

Important traits for Values<'a, V>

impl<'a, V: 'a> Iterator for Values<'a, V> type Item = &'a V;

pub fn values(&self) -> Values<V>

Gets an iterator over the values of this map, in order by key.

Examples

use patricia_tree::PatriciaMap;

let map: PatriciaMap<_> =
    vec![("foo", 1), ("bar", 2), ("baz", 3)].into_iter().collect();
assert_eq!(vec![2, 3, 1],
           map.values().cloned().collect::<Vec<_>>());

Important traits for ValuesMut<'a, V>

impl<'a, V: 'a> Iterator for ValuesMut<'a, V> type Item = &'a mut V;

pub fn values_mut(&mut self) -> ValuesMut<V>

Gets a mutable iterator over the values of this map, in order by key.

Examples

use patricia_tree::PatriciaMap;

let mut map: PatriciaMap<_> =
    vec![("foo", 1), ("bar", 2), ("baz", 3)].into_iter().collect();
for v in map.values_mut() {
    *v += 10;
}
assert_eq!(vec![12, 13, 11],
           map.values().cloned().collect::<Vec<_>>());

Trait Implementations

impl<V> AsRef<Node<V>> for PatriciaMap<V>

fn as_ref(&self) -> &Node<V>

Performs the conversion.

impl<V> From<Node<V>> for PatriciaMap<V>

fn from(f: Node<V>) -> Self

Performs the conversion.

impl<V> From<PatriciaMap<V>> for Node<V>

fn from(f: PatriciaMap<V>) -> Self

Performs the conversion.

impl<K, V> Extend<(K, V)> for PatriciaMap<V> where
    K: AsRef<[u8]>, 

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

Extends a collection with the contents of an iterator.

impl<V> IntoIterator for PatriciaMap<V>

type Item = (Vec<u8>, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V: Clone> Clone for PatriciaMap<V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Default for PatriciaMap<V>

fn default() -> Self

Returns the "default value" for a type.

impl<V: Debug> Debug for PatriciaMap<V>

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

Formats the value using the given formatter.

impl<K, V> FromIterator<(K, V)> for PatriciaMap<V> where
    K: AsRef<[u8]>, 

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

Creates a value from an iterator.