Struct sorted_vector_map::map::SortedVectorMap

pub struct SortedVectorMap<K, V>(_);

Implementations

impl<K, V> SortedVectorMap<K, V> where
    K: Ord, 

pub fn new() -> SortedVectorMap<K, V>

Creates a new, empty SortedVectorMap.

pub fn with_capacity(capacity: usize) -> SortedVectorMap<K, V>

Creates a new, empty SortedVectorMap, with capacity for capacity entries.

pub fn clear(&mut self)

Clears the map, removing all elements.

pub fn get<Q: ?Sized>(&self, q: &Q) -> Option<&V> where
    K: Borrow<Q>,
    Q: Ord, 

Returns a reference to the value corresponding to the key.

pub fn get_key_value<Q: ?Sized>(&self, q: &Q) -> Option<(&K, &V)> where
    K: Borrow<Q>,
    Q: Ord, 

Returns the key-value pair corresponding to the key.

pub fn contains_key<Q: ?Sized>(&self, q: &Q) -> bool where
    K: Borrow<Q>,
    Q: Ord, 

Returns true if the map contains a value for the specified key.

pub fn get_mut<Q: ?Sized>(&mut self, q: &Q) -> Option<&mut V> where
    K: Borrow<Q>,
    Q: Ord, 

Returns a mutable reference to the value corresponding to the key.

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

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated and the old value is returned. They key is not updated, though; this matters for types that can be == without being identical.

If the map did not have the key present, and the key is greater than all of the keys already present, insertion is amortized O(1). Otherwise, insertion is O(n).

pub fn remove<Q: ?Sized>(&mut self, q: &Q) -> Option<V> where
    K: Borrow<Q>,
    Q: Ord, 

Removes a key-value pair from the map, returning the value if the key was previously in the map.

pub fn append(&mut self, other: &mut SortedVectorMap<K, V>)

Moves all elements from other into Self, leaving other empty.

pub fn range<Q: ?Sized, R>(&self, range: R) -> Iter<K, V> where
    K: Borrow<Q>,
    Q: Ord,
    R: RangeBounds<Q>, 

Returns an iterator over the given range of keys.

Panics

Panics if the range start is after the range end.

pub fn range_mut<Q: ?Sized, R>(&mut self, range: R) -> IterMut<K, V> where
    K: Borrow<Q>,
    Q: Ord,
    R: RangeBounds<Q>, 

Returns a mutable iterator over the given range of keys.

Panics

Panics if the range start is after the range end.

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

Gets the given key's corresponding entry in the map for in-place manipulation.

pub fn split_off<Q: ?Sized>(&mut self, q: &Q) -> SortedVectorMap<K, V> where
    K: Borrow<Q>,
    Q: Ord, 

Splits the collection in two at the given key. Returns everything after the given key, including the key.

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

Returns an iterator over the pairs of entries in the map.

pub fn iter_mut(&mut self) -> IterMut<K, V>

Returns a mutable iterator over the pairs of entries in the map.

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

Returns an iterator over the keys of the map, in sorted order.

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

Returns an iterator over the values of the map, in order by key.

pub fn values_mut(&mut self) -> ValuesMut<K, V>

Returns a mutable iterator over the values of the map, in order by key.

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.

Trait Implementations

impl<K, V> Arbitrary for SortedVectorMap<K, V> where
    K: Arbitrary + Ord,
    V: Arbitrary, 

fn arbitrary<G: Gen>(g: &mut G) -> SortedVectorMap<K, V>

fn shrink(&self) -> Box<dyn Iterator<Item = SortedVectorMap<K, V>>>

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for SortedVectorMap<K, V> where
    K: Ord + Debug,
    V: Debug, 

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

Formats the value using the given formatter.

impl<K, V> Default for SortedVectorMap<K, V> where
    K: Ord, 

fn default() -> SortedVectorMap<K, V>

Returns the "default value" for a type.

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

impl<'a, K, V> Extend<(&'a K, &'a V)> for SortedVectorMap<K, V> where
    K: Ord + Copy,
    V: Copy, 

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

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> Extend<(K, V)> for SortedVectorMap<K, V> where
    K: Ord, 

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

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> FromIterator<(K, V)> for SortedVectorMap<K, V> where
    K: Ord, 

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> SortedVectorMap<K, V>

Creates a value from an iterator.

impl<K: Hash, V: Hash> Hash for SortedVectorMap<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, 

Feeds a slice of this type into the given [Hasher].

impl<'_, K, Q: ?Sized, V> Index<&'_ Q> for SortedVectorMap<K, V> where
    K: Ord + Borrow<Q>,
    Q: Ord, 

type Output = V

The returned type after indexing.

fn index(&self, q: &Q) -> &V

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the SortedVectorMap.

impl<'_, K, Q: ?Sized, V> IndexMut<&'_ Q> for SortedVectorMap<K, V> where
    K: Ord + Borrow<Q>,
    Q: Ord, 

fn index_mut(&mut self, q: &Q) -> &mut V

Returns a mutable reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the SortedVectorMap.

impl<K, V> IntoIterator for SortedVectorMap<K, V> where
    K: Ord, 

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) -> IntoIter<(K, V)>

Creates an iterator from a value.

impl<'a, K: 'a, V: 'a> IntoIterator for &'a SortedVectorMap<K, V> where
    K: Ord, 

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) -> Iter<'a, K, V>

Creates an iterator from a value.

impl<'a, K: 'a, V: 'a> IntoIterator for &'a mut SortedVectorMap<K, V> where
    K: Ord, 

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, K, V>

Creates an iterator from a value.

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

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

fn ne(&self, other: &SortedVectorMap<K, V>) -> bool

This method tests for !=.

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

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

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

fn lt(&self, other: &SortedVectorMap<K, V>) -> bool

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

fn le(&self, other: &SortedVectorMap<K, V>) -> bool

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

fn gt(&self, other: &SortedVectorMap<K, V>) -> bool

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

fn ge(&self, other: &SortedVectorMap<K, V>) -> bool

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

impl<K, V> StructuralEq for SortedVectorMap<K, V>

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