Struct ds_ext::map::OrdHashMap

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

A [HashMap] ordered by key using a OrdHashSet

Implementations

impl<K, V> OrdHashMap<K, V>

pub fn new() -> Self

Construct a new OrdHashMap.

pub fn with_capacity(capacity: usize) -> Self

Construct a new OrdHashMap with the given capacity.

pub fn len(&self) -> usize

Return the size of this OrdHashMap.

impl<K: Eq + Hash + Ord, V> OrdHashMap<K, V>

pub fn bisect<Cmp>(&self, cmp: Cmp) -> Option<&V>

where Cmp: Fn(&K) -> Option<Ordering> + Copy,

Bisect this map to match a key using the provided comparison, and return its value (if any).

The first key for which the comparison returns Some(Ordering::Equal) will be returned. This method assumes that any partially-ordered keys (where cmp(key).is_none()) lie at the beginning and/or end of the distribution.

pub fn clear(&mut self)

Remove all entries from this OrdHashMap.

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

where Arc<K>: Borrow<Q>, Q: Eq + Hash + ?Sized,

Return true if there is an entry for the given key in this OrdHashMap.

pub fn drain(&mut self) -> Drain<'_, K, V>

Drain all entries from this OrdHashMap.

pub fn drain_while<Cond>(&mut self, cond: Cond) -> DrainWhile<'_, K, V, Cond>

where Cond: Fn((&K, &V)) -> bool,

Drain all entries from this OrdHashMap.

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

Return a mutable Entry in this OrdHashMap.

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

Consume iter and insert all its elements into this OrdHashMap.

pub fn first(&self) -> Option<&V>

Borrow the first value in this OrdHashMap.

pub fn first_mut(&mut self) -> Option<&mut V>

Borrow the first value in this OrdHashMap mutably.

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

where Arc<K>: Borrow<Q>, Q: Eq + Hash + ?Sized,

Borrow the value at the given key, if present.

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

where Arc<K>: Borrow<Q>, Q: Eq + Hash + ?Sized,

Borrow the entry at the given key, if present.

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

where Arc<K>: Borrow<Q>, Q: Eq + Hash + ?Sized,

Borrow the value at the given key mutably, if present.

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

Insert a new value at key and return the previous value, if any.

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

Construct an iterator over the entries in this OrdHashMap.

pub fn is_empty(&self) -> bool

Return true if this OrdHashMap is empty.

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

Construct an iterator over keys of this OrdHashMap.

pub fn last(&self) -> Option<&V>

Borrow the last value in this OrdHashMap.

pub fn last_mut(&mut self) -> Option<&mut V>

Borrow the last value in this OrdHashMap mutably.

pub fn pop_first(&mut self) -> Option<V>

where K: Debug,

Remove and return the first value in this OrdHashMap.

pub fn pop_last(&mut self) -> Option<V>

where K: Debug,

Remove and return the last value in this OrdHashMap.

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

where Arc<K>: Borrow<Q>, Q: Hash + Eq + ?Sized,

Remove an entry from this OrdHashMap and return its value, if present.

pub fn starts_with<'a, I: IntoIterator<Item = (&'a K, &'a V)>>( &self, other: I, ) -> bool

where K: Debug + 'a, V: PartialEq + 'a,

Return true if the first elements in this OrdHashMap equal those in the given iter.

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

where K: Debug,

Construct an owned iterator over the values in this OrdHashMap.

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

Construct an iterator over the values in this OrdHashMap.

impl<K: Eq + Hash + Ord + Debug, V> OrdHashMap<K, V>

pub fn bisect_and_remove<Cmp>(&mut self, cmp: Cmp) -> Option<(K, V)>

where Cmp: Fn(&K) -> Option<Ordering> + Copy,

Bisect this map to match and remove an entry using the provided comparison.

The first key for which the comparison returns Some(Ordering::Equal) will be returned. This method assumes that any partially-ordered keys (where cmp(key).is_none()) lie at the beginning and/or end of the distribution.

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

Remove and return the first entry in this OrdHashMap.

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

Remove and return the last entry in this OrdHashMap.

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

where Arc<K>: Borrow<Q>, Q: Hash + Eq + ?Sized,

Remove and return an entry from this OrdHashMap, if present.

Trait Implementations

impl<K: Clone + Eq + Hash + Ord + Debug, V: Clone> Clone for OrdHashMap<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Eq + Hash + Ord + Debug, V: Debug> Debug for OrdHashMap<K, V>

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

Formats the value using the given formatter.

impl<K: Eq + Hash + Ord + Debug, V> FromIterator<(K, V)> for OrdHashMap<K, V>

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

Creates a value from an iterator.

impl<K: GetSize, V: GetSize> GetSize for OrdHashMap<K, V>

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

impl<'a, K: Ord + Eq + Hash + Debug, V> IntoIterator for &'a OrdHashMap<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<K: Eq + Hash + Debug, V> IntoIterator for OrdHashMap<K, V>

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: Eq + Hash + Ord + Debug, V: PartialEq> PartialEq for OrdHashMap<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: &Rhs) -> bool

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

impl<K: Eq + Hash + Ord + Debug, V: Eq> Eq for OrdHashMap<K, V>