Struct storagevec::smap::StorageMap

#[repr(transparent)]pub struct StorageMap<K: Eq + Ord + Hash, V, const N: usize>(_);

A map object that with either use the tinymap TinyMap or the hashbrown HashMap as a backing implementation. It will use the alloc feature to control this.

Implementations

impl<K: Eq + Ord + Hash, V, const N: usize> StorageMap<K, V, N>

#[must_use]pub fn new() -> Self

Create a new, empty StorageMap.

#[must_use]pub fn len(&self) -> usize

Get the length of this storage map.

#[must_use]pub fn is_empty(&self) -> bool

Tell whether or not the storage map is empty.

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

Get an element from this map by its key.

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

Get a mutable reference to an element by its key.

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

Insert a new element into this map. If the key already exists in the map, it returns the value previously held in that slot. Otherwise, it will return None.

Errors

It will return back the key-value pair if the insertion cannot be accomplished due to capacity overflow.

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

Insert a new element into this map.

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

Remove a key/value entry from this map.

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

Remove a value from this map.

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

Tell whether this map contains a certain key.

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

Get an iterator that iterates over the key-value pairs in arbitrary order.

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

Get an iterator that iterates over the key-value pairs in arbitary order, mutably.

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

Get an iterator that iterates over the keys in arbitrary order.

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

Get an iterator that iterates over the values in arbitrary order.

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

Get an iterator that iterates over the values in arbitrary order, mutably.

Trait Implementations

impl<K: Ord + Eq + Hash + Clone, V: Clone, const N: usize> Clone for StorageMap<K, V, N>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Ord + Eq + Hash + Debug, V: Debug, const N: usize> Debug for StorageMap<K, V, N>

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

Formats the value using the given formatter.

impl<K: Ord + Eq + Hash, V, const N: usize> Default for StorageMap<K, V, N>

pub fn default() -> Self

Returns the "default value" for a type.

impl<K: Ord + Eq + Hash, V, const N: usize> Extend<(K, V)> for StorageMap<K, V, N>

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 + Eq + Hash, V, const N: usize> FromIterator<(K, V)> for StorageMap<K, V, N>

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

Creates a value from an iterator.

impl<K: Ord + Eq + Hash, V, const N: usize> IntoIterator for StorageMap<K, V, N>

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?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.