Struct EnumMap 

pub struct EnumMap<K: EnumId, V> { /* private fields */ }

A map from an EnumId key to values, implemented using an inline array.

This is similar to a EnumMap and is also “direct”, although that is omitted from the name for conciseness. Implementing the EnumId trait implies that the ids are relatively compact, although this is not a strict requirement.

There is no entry API because the overhead of lookups is very small.

Implementations

impl<K: EnumId, V> EnumMap<K, V>

pub fn new() -> Self

Create a new map with no entries.

pub fn new_boxed() -> Box<Self>

Create a new map with no entries, allocating memory on the heap instead of the stack.

Using Box::new(EnumMapDirect::new()) could require moving the underlying table from the stack to the heap, as LLVM can struggle at eliminating copies. This method avoids that copy by always allocating in-place.

pub fn len(&self) -> usize

The number of entries in the map.

pub fn is_empty(&self) -> bool

Return true if this map is empty.

pub fn clear(&mut self)

Clear all entries in the map.

pub fn contains_key(&self, id: impl EquivalentId<K>) -> bool

Check if the specified key is present in the map.

pub fn get(&self, id: impl EquivalentId<K>) -> Option<&V>

Get the value associated with the specified key, or None if missing.

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

Get a mutable reference to the value associated with the specified key, or None if missing.

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

Insert a key and a value, returning the previous value.

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

Remove a value associated with the given, returning the previous value ifp resent.

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

Iterate over the key-value pairs in the map.

Guaranteed to be sorted by the integer id of the key.

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

Mutably iterate over the key-value pairs in the map.

Guaranteed to be sorted by the integer id of the key.

pub fn retain(&mut self, func: impl FnMut(K, &mut V) -> bool)

Iterate over the entries in the map, removing entries when the callback returns false.

See also std::collections::HashMap::retain.

Trait Implementations

impl<K: Clone + EnumId, V: Clone> Clone for EnumMap<K, V>

where K::Array<Option<V>>: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: EnumId, V: Debug> Debug for EnumMap<K, V>

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

Formats the value using the given formatter.

impl<K: EnumId, V> Default for EnumMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K, V> Deserialize<'de> for EnumMap<K, V>

where K: Deserialize<'de> + EnumId, V: Deserialize<'de>,

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<'a, K: EnumId, V: Clone> Extend<(K, &'a V)> for EnumMap<K, V>

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

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: EnumId, V> Extend<(K, V)> for EnumMap<K, V>

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

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<'a, K: EnumId, V: Clone> FromIterator<(K, &'a V)> for EnumMap<K, V>

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

Creates a value from an iterator.

impl<K: EnumId, V> FromIterator<(K, V)> for EnumMap<K, V>

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

Creates a value from an iterator.

impl<'a, K: EnumId, V> Index<&'a K> for EnumMap<K, V>

type Output = V

The returned type after indexing.

fn index(&self, index: &'a K) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<K: EnumId, V> Index<K> for EnumMap<K, V>

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, K: EnumId, V> IndexMut<&'a K> for EnumMap<K, V>

fn index_mut(&mut self, index: &'a K) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<K: EnumId, V> IndexMut<K> for EnumMap<K, V>

fn index_mut(&mut self, index: K) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, K: EnumId, V> IntoIterator for &'a EnumMap<K, V>

type Item = (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<'a, K: EnumId, V> IntoIterator for &'a mut EnumMap<K, V>

type Item = (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) -> Self::IntoIter

Creates an iterator from a value.

impl<K: EnumId, V> IntoIterator for EnumMap<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: EnumId, V: PartialEq> PartialEq for EnumMap<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, V> Serialize for EnumMap<K, V>

where K: EnumId + Serialize, V: Serialize,

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<K: EnumId, V: Eq> Eq for EnumMap<K, V>