Struct BTreeMap 

pub struct BTreeMap<'store, K, V> { /* private fields */ }

A copyable, immutable b-tree map, which doesn’t drop its contents.

Implementations

impl<'store, K, V> BTreeMap<'store, K, V>

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

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

where K: Borrow<Q>,

Whether the map contains the key

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

where K: Borrow<Q>,

Returns a reference to the value corresponding to the key.

pub fn get_key<Q: Ord>(&self, key: &Q) -> Option<&K>

where K: Borrow<Q>,

Returns a reference to the equivalent key

This is (only) useful when Q is a different type than K.

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

where K: Borrow<Q>,

Returns a reference to the equivalent key and associated value

This is (only) useful when Q is a different type than K.

pub fn first_key_value(&self) -> Option<(&K, &V)>

Returns the first key and value

pub fn last_key_value(&self) -> Option<(&K, &V)>

Returns the last key and value

pub fn validate(&self)

where K: Debug + Ord, V: Debug,

Validates the map, panicing if it is invalid. Specifically, we check that the number of entries in each node is within the b-tree invariant bounds, and that the keys are in order.

Ideally, this should always be a no-op.

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

where K: Debug, V: Debug,

Prints the b-tree in ascii

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

Iterates over the map’s key-value pairs in order.

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

Iterates over the map’s keys in order.

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

Iterates over the map’s values in order.

pub fn range<Q: Ord>(&self, bounds: impl RangeBounds<Q>) -> Range<'_, K, V>

where K: Borrow<Q>,

Iterates over the map’s key-value pairs in order, within the given range.

pub fn range_keys<Q: Ord>( &self, bounds: impl RangeBounds<Q>, ) -> impl Iterator<Item = &K> + '_

where K: Borrow<Q>,

Iterates over the map’s keys in order, within the given range.

pub fn range_values<Q: Ord>( &self, bounds: impl RangeBounds<Q>, ) -> impl Iterator<Item = &V> + '_

where K: Borrow<Q>,

Iterates over the map’s values in order, within the given range.

Trait Implementations

impl<'store, K, V> Clone for BTreeMap<'store, K, V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'store, K: Debug, V: Debug> Debug for BTreeMap<'store, K, V>

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

Formats the value using the given formatter.

impl<'store, K, V> From<BTreeMap<'store, K, V>> for BTreeMap<'store, K, V>

fn from(inner: BTreeMap<'store, K, V>) -> Self

Creates a copyable map from a non-copyable map. Afterwards, the map is no longer mutable and will no longer drop its contents.

impl<'store, K: Hash, V: Hash> Hash for BTreeMap<'store, 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<'store: 'a, 'a, K, V> IntoIterator for &'a BTreeMap<'store, K, V>

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'store, K: Ord, V: Ord> Ord for BTreeMap<'store, K, V>

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl<'store, K: PartialEq, V: PartialEq> PartialEq for BTreeMap<'store, K, V>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'store, K: PartialOrd, V: PartialOrd> PartialOrd for BTreeMap<'store, K, V>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'store, K, V> Copy for BTreeMap<'store, K, V>

impl<'store, K: Eq, V: Eq> Eq for BTreeMap<'store, K, V>