pub struct SortedMap<K, V> {
    data: Vec<(K, V)>,
}
Expand description

SortedMap is a data structure with similar characteristics as BTreeMap but slightly different trade-offs: lookup is O(log(n)), insertion and removal are O(n) but elements can be iterated in order cheaply.

SortedMap can be faster than a BTreeMap for small sizes (<50) since it stores data in a more compact way. It also supports accessing contiguous ranges of elements as a slice, and slices of already sorted elements can be inserted efficiently.

Fields§

§data: Vec<(K, V)>

Implementations§

source§

impl<K, V> SortedMap<K, V>

source

pub const fn new() -> SortedMap<K, V>

source§

impl<K: Ord, V> SortedMap<K, V>

source

pub fn from_presorted_elements(elements: Vec<(K, V)>) -> SortedMap<K, V>

Construct a SortedMap from a presorted set of elements. This is faster than creating an empty map and then inserting the elements individually.

It is up to the caller to make sure that the elements are sorted by key and that there are no duplicates.

source

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

source

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

source

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

source

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

source

pub fn get_mut_or_insert_default(&mut self, key: K) -> &mut V
where K: Eq, V: Default,

Gets a mutable reference to the value in the entry, or insert a new one.

source

pub fn clear(&mut self)

source

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

Iterate over elements, sorted by key

source

pub fn keys( &self ) -> impl Iterator<Item = &K> + ExactSizeIterator + DoubleEndedIterator

Iterate over the keys, sorted

source

pub fn values( &self ) -> impl Iterator<Item = &V> + ExactSizeIterator + DoubleEndedIterator

Iterate over values, sorted by key

source

pub fn len(&self) -> usize

source

pub fn is_empty(&self) -> bool

source

pub fn range<R>(&self, range: R) -> &[(K, V)]
where R: RangeBounds<K>,

source

pub fn remove_range<R>(&mut self, range: R)
where R: RangeBounds<K>,

source

pub fn offset_keys<F>(&mut self, f: F)
where F: Fn(&mut K),

Mutate all keys with the given function f. This mutation must not change the sort-order of keys.

source

pub fn insert_presorted(&mut self, elements: Vec<(K, V)>)

Inserts a presorted range of elements into the map. If the range can be inserted as a whole in between to existing elements of the map, this will be faster than inserting the elements individually.

It is up to the caller to make sure that the elements are sorted by key and that there are no duplicates.

source

fn lookup_index_for<Q>(&self, key: &Q) -> Result<usize, usize>
where K: Borrow<Q>, Q: Ord + ?Sized,

Looks up the key in self.data via slice::binary_search().

source

fn range_slice_indices<R>(&self, range: R) -> (usize, usize)
where R: RangeBounds<K>,

source

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

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<K: Debug, V: Debug> Debug for SortedMap<K, V>

source§

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

Formats the value using the given formatter. Read more
source§

impl<K, V, __D: Decoder> Decodable<__D> for SortedMap<K, V>
where K: Decodable<__D>, V: Decodable<__D>,

source§

fn decode(__decoder: &mut __D) -> Self

source§

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

source§

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

Returns the “default value” for a type. Read more
source§

impl<K, V, __E: Encoder> Encodable<__E> for SortedMap<K, V>
where K: Encodable<__E>, V: Encodable<__E>,

source§

fn encode(&self, __encoder: &mut __E)

source§

impl<K: Ord, V> FromIterator<(K, V)> for SortedMap<K, V>

source§

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

Creates a value from an iterator. Read more
source§

impl<K: Hash, V: Hash> Hash for SortedMap<K, V>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<K: HashStable<CTX> + StableOrd, V: HashStable<CTX>, CTX> HashStable<CTX> for SortedMap<K, V>

source§

fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher)

source§

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

§

type Output = V

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

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

source§

fn index_mut(&mut self, key: &Q) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<K: Ord, V> IntoIterator for SortedMap<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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

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

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

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

source§

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

Auto Trait Implementations§

§

impl<K, V> RefUnwindSafe for SortedMap<K, V>

§

impl<K, V> Send for SortedMap<K, V>
where K: Send, V: Send,

§

impl<K, V> Sync for SortedMap<K, V>
where K: Sync, V: Sync,

§

impl<K, V> Unpin for SortedMap<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnwindSafe for SortedMap<K, V>
where K: UnwindSafe, V: UnwindSafe,

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = const ALIGN: Alignment = Alignment::of::<Self>();

Alignment of Self.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes