Struct TotalBTreeMap 

pub struct TotalBTreeMap<K, V, C = DefaultCommonality> { /* private fields */ }

An ordered map in which every possible key has an associated value. Only entries with uncommon values are actually stored in the map; all other keys are presumed to be associated with a common value.

See the crate documentation for more information.

The API is more-or-less a subset of that of BTreeMap. However, methods that treat this type like a collection (for example, len() and iter()) operate only on the uncommon entries.

Implementations

impl<K, V, C> TotalBTreeMap<K, V, C>

pub fn new() -> Self

Constructs a TotalBTreeMap in which all keys are associated with the common value.

impl<K, V, C> TotalBTreeMap<K, V, C>

pub fn len(&self) -> usize

Returns the number of uncommon entries in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no uncommon entries.

pub fn clear(&mut self)

Resets all entries in the map to the common value.

impl<K: Ord, V, C> TotalBTreeMap<K, V, C>

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

where K: Borrow<Q>, Q: Ord + ?Sized,

Returns true if the map contains an uncommon entry with the given key.

impl<K: Ord, V, C: Commonality<V>> TotalBTreeMap<K, V, C>

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

where K: Borrow<Q>, Q: Ord + ?Sized,

Returns a reference to the value associated with the given key.

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

Associates a key with a value in the map, and returns the value previously associated with that key.

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

where K: Borrow<Q>, Q: Ord + ?Sized,

Associates a key with the common value in the map, and returns the value previously associated with that key.

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

Gets the given key’s associated entry in the map for in-place manipulation.

pub fn uncommon_entry<'a, Q>( &'a mut self, key: &'a Q, ) -> Option<Entry<'a, Q, K, V, C>>

where K: Borrow<Q>, Q: Ord + ?Sized,

Gets the given key’s associated entry in the map if it has an uncommon value; otherwise returns None.

In contrast with Self::entry, this method accepts the key in borrowed form.

impl<K, V, C> TotalBTreeMap<K, V, C>

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

An iterator over all keys associated with uncommon values in the map, in sorted order.

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

Creates a consuming iterator over all keys associated with uncommon values in the map, in sorted order.

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

An iterator over all uncommon values in the map, in sorted order.

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

Creates a consuming iterator over all uncommon values in the map, in sorted order.

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

An iterator over all uncommon entries in the map, in sorted order.

impl<K, V, C> TotalBTreeMap<K, V, C>

pub fn as_btree_map(&self) -> &BTreeMap<K, V>

Returns a view into the underlying BTreeMap of a TotalBTreeMap, which contains the uncommon entries.

impl<K: Ord, V, C: Commonality<V>> TotalBTreeMap<K, V, C>

pub fn as_btree_map_mut(&mut self) -> AsBTreeMapMut<'_, K, V, C>

Returns a mutable view into the underlying BTreeMap of a TotalBTreeMap, from which mutating iterators can be obtained by calling BTreeMap::values_mut or BTreeMap::iter_mut.

By directly mutating the underlying BTreeMap, it is possible to store uncommon entries in the map temporarily. When the returned view is dropped, all uncommon entries will be removed, restoring the invariant of TotalBTreeMap.

You don’t need this method if you are only mutating individual entries; use the entry method instead.

Trait Implementations

impl<K: Clone, V: Clone, C> Clone for TotalBTreeMap<K, V, C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, V, C: Commonality<V>> Commonality<TotalBTreeMap<K, V, C>> for EmptyCommonality

fn common() -> TotalBTreeMap<K, V, C>

The common value of type V.

fn is_common(value: &TotalBTreeMap<K, V, C>) -> bool

Returns true if value is the common value of type V. Self::is_common(Self::common()) must be true.

impl<K: Debug, V: Debug, C> Debug for TotalBTreeMap<K, V, C>

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

Formats the value using the given formatter.

impl<K, V, C> Default for TotalBTreeMap<K, V, C>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K: Deserialize<'de> + Ord, V: Deserialize<'de>, C: Commonality<V>> Deserialize<'de> for TotalBTreeMap<K, V, C>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: Ord, V, C: Commonality<V>> Extend<(K, V)> for TotalBTreeMap<K, V, C>

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

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: Ord, V, C: Commonality<V>> FromIterator<(K, V)> for TotalBTreeMap<K, V, C>

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

Creates a value from an iterator.

impl<K: Hash, V: Hash, C> Hash for TotalBTreeMap<K, V, C>

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: Borrow<Q> + Ord, Q: Ord + ?Sized, V, C: Commonality<V>> Index<&Q> for TotalBTreeMap<K, V, C>

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, K, V, C> IntoIterator for &'a TotalBTreeMap<K, V, C>

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<K, V, C> IntoIterator for TotalBTreeMap<K, V, C>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Ord, V: Ord, C> Ord for TotalBTreeMap<K, V, C>

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<K: PartialEq, V: PartialEq, C> PartialEq for TotalBTreeMap<K, V, C>

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

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

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

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

impl<K: PartialOrd, V: PartialOrd, C> PartialOrd for TotalBTreeMap<K, V, C>

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<K: Serialize, V: Serialize, C> Serialize for TotalBTreeMap<K, V, C>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<K: Eq, V: Eq, C> Eq for TotalBTreeMap<K, V, C>