Struct pfx::map::PrefixTreeMap

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

An ordered map from byte strings to arbitrary values, based on a prefix tree.

Implementations

impl<K, V> PrefixTreeMap<K, V>

pub const fn new() -> Self

Creates an empty map. The same as Default.

pub const fn len(&self) -> usize

Returns the number of entries (key-value pairs) in the map.

pub const fn is_empty(&self) -> bool

Returns true if and only if this map contains no key-value pairs.

pub fn get_entry<Q>(&self, key: &Q) -> Option<(&K, &V)>

where Q: ?Sized + AsRef<[u8]>,

Return a reference to the original key and value, if found.

pub fn get_entry_mut<Q>(&mut self, key: &Q) -> Option<(&K, &mut V)>

where Q: ?Sized + AsRef<[u8]>,

Return a reference to the original key and a mutable reference to the value, if found.

pub fn get<Q>(&self, key: &Q) -> Option<&V>

where Q: ?Sized + AsRef<[u8]>,

Return a reference to the value, if found.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>

where Q: ?Sized + AsRef<[u8]>,

Return a mutable reference to the value, if found.

pub fn contains_key<Q>(&self, key: &Q) -> bool

where Q: ?Sized + AsRef<[u8]>,

Returns true if and only if the given key is found in the map.

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>

where Q: ?Sized + AsRef<[u8]>,

If the key exists in the map, return the original key and the correpsonding value.

pub fn remove<Q>(&mut self, key: &Q) -> Option<V>

where Q: ?Sized + AsRef<[u8]>,

If the key exists in the map, return the corresponding value.

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

An iterator over pairs of references to keys and the corresponding values.

Iteration proceeds in lexicographic order, as determined by the byte sequence of keys.

pub fn into_keys(self) -> IntoKeys<K, V>

An iterator over the owned keys.

Iteration proceeds in lexicographic order, as determined by the byte sequence of keys.

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

An iterator over the borrowed keys.

Iteration proceeds in lexicographic order, as determined by the byte sequence of keys.

pub fn into_values(self) -> IntoValues<K, V>

An iterator over the owned values.

Iteration proceeds in lexicographic order, as determined by the byte sequence of keys.

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

An iterator over the borrowed values.

Iteration proceeds in lexicographic order, as determined by the byte sequence of keys.

pub fn into_prefix_iter<Q>(self, prefix: &Q) -> NodeIntoIter<K, V>

where Q: ?Sized + AsRef<[u8]>,

An iterator over owned key-value pairs of which the key starts with the given prefix.

Iteration proceeds in lexicographic order, as determined by the byte sequence of keys.

pub fn prefix_iter<Q>(&self, prefix: &Q) -> NodeIter<'_, K, V>

where Q: ?Sized + AsRef<[u8]>,

An iterator over borrowed key-value pairs of which the key starts with the given prefix.

Iteration proceeds in lexicographic order, as determined by the byte sequence of keys.

pub fn compact(&mut self)

Removes all internal nodes that do not contain an entry.

This is useful for freeing up memory and speeding up iteration after removing many key-value pairs from the map and/or after creating many spurious nodes using the entry API (by not inserting into the nodes created by .entry()).

impl<K, V> PrefixTreeMap<K, V>

where K: AsRef<[u8]>,

pub fn entry(&mut self, key: K) -> Entry<'_, K, V>

Return an object representing the (vacant or occupied) node of the tree corresponding to the given key.

This always creates a new node, even if you don’t end up inserting into it. Avoid creating many spurious entries, or call PrefixTreeMap::compact to remove useless (empty) nodes.

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

Replaces and returns the previous value, if any.

This leaves the key in the map untouched if it already exists.

pub fn union<I>(self, other: I) -> Self

where I: IntoIterator<Item = (K, V)>,

Takes the union of self with another set of elements. Elements that already exist in self will be overwritten by other.

pub fn union_in_place<I>(&mut self, other: I)

where I: IntoIterator<Item = (K, V)>,

Takes the union of self with another set of elements. Elements that already exist in self will be overwritten by other.

pub fn intersection<I>(self, other: I) -> Self

where I: IntoIterator, I::Item: AsRef<[u8]>,

Takes the intersection of self with another set of elements. The intersection is solely based on the keys.

pub fn difference<I>(self, other: I) -> Self

where I: IntoIterator, I::Item: AsRef<[u8]>,

Removes the items corresponding to keys in other from self.

pub fn difference_in_place<I>(&mut self, other: I)

where I: IntoIterator, I::Item: AsRef<[u8]>,

Removes the items corresponding to keys in other from self.

pub fn symmetric_difference<I>(self, other: I) -> Self

where I: IntoIterator<Item = (K, V)>,

Add elements that are missing from self, and remove elements contained in self.

Containment is tested by comparing keys only. Values are not checked for equality.

pub fn symmetric_difference_in_place<I>(&mut self, other: I)

where I: IntoIterator<Item = (K, V)>,

Add elements that are missing from self, and remove elements contained in self.

Containment is tested by comparing keys only. Values are not checked for equality.

Trait Implementations

impl<I, K, V> BitAnd<I> for PrefixTreeMap<K, V>

where I: IntoIterator, I::Item: AsRef<[u8]>, K: AsRef<[u8]>,

Creates the intersection of self and other.

type Output = PrefixTreeMap<K, V>

The resulting type after applying the & operator.

fn bitand(self, other: I) -> Self::Output

Performs the & operation.

impl<I, K, V> BitAndAssign<I> for PrefixTreeMap<K, V>

where I: IntoIterator, I::Item: AsRef<[u8]>, K: AsRef<[u8]>,

Creates the intersection of self and other.

fn bitand_assign(&mut self, other: I)

Performs the &= operation.

impl<I, K, V> BitOr<I> for PrefixTreeMap<K, V>

where I: IntoIterator<Item = (K, V)>, K: AsRef<[u8]>,

Creates the union of self and other.

type Output = PrefixTreeMap<K, V>

The resulting type after applying the | operator.

fn bitor(self, other: I) -> Self::Output

Performs the | operation.

impl<I, K, V> BitOrAssign<I> for PrefixTreeMap<K, V>

where I: IntoIterator<Item = (K, V)>, K: AsRef<[u8]>,

Creates the union of self and other.

fn bitor_assign(&mut self, other: I)

Performs the |= operation.

impl<I, K, V> BitXor<I> for PrefixTreeMap<K, V>

where I: IntoIterator<Item = (K, V)>, K: AsRef<[u8]>,

Creates the symmetric difference of self and other.

type Output = PrefixTreeMap<K, V>

The resulting type after applying the ^ operator.

fn bitxor(self, other: I) -> Self::Output

Performs the ^ operation.

impl<I, K, V> BitXorAssign<I> for PrefixTreeMap<K, V>

where I: IntoIterator<Item = (K, V)>, K: AsRef<[u8]>,

Creates the symmetric difference of self and other.

fn bitxor_assign(&mut self, other: I)

Performs the ^= operation.

impl<K: Clone, V: Clone> Clone for PrefixTreeMap<K, V>

fn clone(&self) -> PrefixTreeMap<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for PrefixTreeMap<K, V>

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

Formats the value using the given formatter.

impl<K, V> Default for PrefixTreeMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Extend<(K, V)> for PrefixTreeMap<K, 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.

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<K, V, const N: usize> From<[(K, V); N]> for PrefixTreeMap<K, V>

where K: AsRef<[u8]>,

fn from(items: [(K, V); N]) -> Self

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for PrefixTreeMap<K, V>

where K: AsRef<[u8]>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<K: Hash, V: Hash> Hash for PrefixTreeMap<K, V>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K, V, Q> Index<&Q> for PrefixTreeMap<K, V>

where K: AsRef<[u8]>, Q: ?Sized + AsRef<[u8]>,

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, K, V> IntoIterator for &'a PrefixTreeMap<K, V>

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> IntoIterator for PrefixTreeMap<K, V>

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

type Item = (K, V)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Ord, V: Ord> Ord for PrefixTreeMap<K, V>

fn cmp(&self, other: &PrefixTreeMap<K, V>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<K: PartialEq, V: PartialEq> PartialEq for PrefixTreeMap<K, V>

fn eq(&self, other: &PrefixTreeMap<K, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K: PartialOrd, V: PartialOrd> PartialOrd for PrefixTreeMap<K, V>

fn partial_cmp(&self, other: &PrefixTreeMap<K, V>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K: Eq, V: Eq> Eq for PrefixTreeMap<K, V>

impl<K, V> StructuralPartialEq for PrefixTreeMap<K, V>