pub enum SsoHashMap<K, V> {
    Array(ArrayVec<(K, V), SSO_ARRAY_SIZE>),
    Map(FxHashMap<K, V>),
}
Expand description

Small-storage-optimized implementation of a map.

Stores elements in a small array up to a certain length and switches to HashMap when that length is exceeded.

Variants§

§

Array(ArrayVec<(K, V), SSO_ARRAY_SIZE>)

§

Map(FxHashMap<K, V>)

Implementations§

source§

impl<K, V> SsoHashMap<K, V>

source

pub fn new() -> Self

Creates an empty SsoHashMap.

source

pub fn with_capacity(cap: usize) -> Self

Creates an empty SsoHashMap with the specified capacity.

source

pub fn clear(&mut self)

Clears the map, removing all key-value pairs. Keeps the allocated memory for reuse.

source

pub fn capacity(&self) -> usize

Returns the number of elements the map can hold without reallocating.

source

pub fn len(&self) -> usize

Returns the number of elements in the map.

source

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

source

pub fn iter(&self) -> <&Self as IntoIterator>::IntoIter

An iterator visiting all key-value pairs in arbitrary order. The iterator element type is (&'a K, &'a V).

source

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&K, &mut V)>

An iterator visiting all key-value pairs in arbitrary order, with mutable references to the values. The iterator element type is (&'a K, &'a mut V).

source

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

An iterator visiting all keys in arbitrary order. The iterator element type is &'a K.

source

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

An iterator visiting all values in arbitrary order. The iterator element type is &'a V.

source

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut V>

An iterator visiting all values mutably in arbitrary order. The iterator element type is &'a mut V.

source

pub fn drain(&mut self) -> impl Iterator<Item = (K, V)> + '_

Clears the map, returning all key-value pairs as an iterator. Keeps the allocated memory for reuse.

source§

impl<K: Eq + Hash, V> SsoHashMap<K, V>

source

fn migrate_if_full(&mut self)

Changes underlying storage from array to hashmap if array is full.

source

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the SsoHashMap. The collection may reserve more space to avoid frequent reallocations.

source

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the map as much as possible. It will drop down as much as possible while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.

source

pub fn retain<F>(&mut self, f: F)
where F: FnMut(&K, &mut V) -> bool,

Retains only the elements specified by the predicate.

source

pub fn insert(&mut self, key: K, value: 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. The key is not updated, though; this matters for types that can be == without being identical. See the [module-level documentation] for more.

source

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

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

source

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

Removes a key from the map, returning the stored key and value if the key was previously in the map.

source

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

Returns a reference to the value corresponding to the key.

source

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

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

source

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

Returns the key-value pair corresponding to the supplied key.

source

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

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

source

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

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

Trait Implementations§

source§

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

source§

fn clone(&self) -> SsoHashMap<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, V> Debug for SsoHashMap<K, V>
where K: Debug, V: Debug,

source§

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

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

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

source§

fn default() -> Self

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

impl<'a, K, V> Extend<(&'a K, &'a V)> for SsoHashMap<K, V>
where K: Eq + Hash + Copy, V: Copy,

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, (k, v): (&'a K, &'a V))

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl<K: Eq + Hash, V> Extend<(K, V)> for SsoHashMap<K, V>

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, (k, v): (K, V))

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl<K: Eq + Hash, V> FromIterator<(K, V)> for SsoHashMap<K, V>

source§

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

Creates a value from an iterator. Read more
source§

impl<'a, K, V> Index<&'a K> for SsoHashMap<K, V>
where K: Eq + Hash,

§

type Output = V

The returned type after indexing.
source§

fn index(&self, key: &K) -> &V

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

impl<'a, K, V> IntoIterator for &'a SsoHashMap<K, V>

§

type IntoIter = Either<Map<Iter<'a, (K, V)>, fn(_: &'a (K, V)) -> (&'a K, &'a V)>, Iter<'a, K, V>>

Which kind of iterator are we turning this into?
§

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

The type of the elements being iterated over.
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'a, K, V> IntoIterator for &'a mut SsoHashMap<K, V>

§

type IntoIter = Either<Map<IterMut<'a, (K, V)>, fn(_: &'a mut (K, V)) -> (&'a K, &'a mut V)>, IterMut<'a, K, V>>

Which kind of iterator are we turning this into?
§

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

The type of the elements being iterated over.
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<K, V> IntoIterator for SsoHashMap<K, V>

§

type IntoIter = Either<IntoIter<(K, V), 8>, IntoIter<K, V>>

Which kind of iterator are we turning this into?
§

type Item = (K, V)

The type of the elements being iterated over.
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

impl<K, V> UnwindSafe for SsoHashMap<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: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.