Struct Map

pub struct Map<K, V>
where
    K: Copy,
    V: Copy,
{ /* private fields */ }

B-tree mapping from K to V.

This is not a general-purpose replacement for BTreeMap. See the module documentation for more information about design tradeoffs.

Maps can be cloned, but that operation should only be used as part of cloning the whole forest they belong to. Cloning a map does not allocate new memory for the clone. It creates an alias of the same memory.

Implementations

impl<K, V> Map<K, V>

where K: Copy, V: Copy,

pub fn new() -> Self

Make an empty map.

pub fn is_empty(&self) -> bool

Is this an empty map?

pub fn get<C: Comparator<K>>( &self, key: K, forest: &MapForest<K, V>, comp: &C, ) -> Option<V>

Get the value stored for key.

pub fn get_or_less<C: Comparator<K>>( &self, key: K, forest: &MapForest<K, V>, comp: &C, ) -> Option<(K, V)>

Look up the value stored for key.

If it exists, return the stored key-value pair.

Otherwise, return the last key-value pair with a key that is less than or equal to key.

If no stored keys are less than or equal to key, return None.

pub fn insert<C: Comparator<K>>( &mut self, key: K, value: V, forest: &mut MapForest<K, V>, comp: &C, ) -> Option<V>

Insert key, value into the map and return the old value stored for key, if any.

pub fn remove<C: Comparator<K>>( &mut self, key: K, forest: &mut MapForest<K, V>, comp: &C, ) -> Option<V>

Remove key from the map and return the removed value for key, if any.

pub fn clear(&mut self, forest: &mut MapForest<K, V>)

Remove all entries.

pub fn retain<F>(&mut self, forest: &mut MapForest<K, V>, predicate: F)

where F: FnMut(K, &mut V) -> bool,

Retains only the elements specified by the predicate.

Remove all key-value pairs where the predicate returns false.

The predicate is allowed to update the values stored in the map.

pub fn cursor<'a, C: Comparator<K>>( &'a mut self, forest: &'a mut MapForest<K, V>, comp: &'a C, ) -> MapCursor<'a, K, V, C>

Create a cursor for navigating this map. The cursor is initially positioned off the end of the map.

pub fn iter<'a>(&'a self, forest: &'a MapForest<K, V>) -> MapIter<'a, K, V>

Create an iterator traversing this map. The iterator type is (K, V).

Trait Implementations

impl<K, V> Clone for Map<K, V>

where K: Copy + Clone, V: Copy + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where K: Copy, V: Copy,

fn default() -> Self

Returns the “default value” for a type.