Struct array_map::ArrayMap

pub struct ArrayMap<K, V, const N: usize> { /* fields omitted */ }

A Map backed by an array. The keys must be known statically.

This map is O(1) for all operations. All members must be initialized at creation time so there is no option to insert or remove items from the map. Because of this it can be indexed into using the key type.

Implementations

impl<K: Indexable, V: Clone, const N: usize> ArrayMap<K, V, N>

pub fn from_value(v: V) -> Self

Returns a new ArrayMap where all the values are initialized to the same value

impl<K: Indexable, V, const N: usize> ArrayMap<K, V, N>

pub fn from_closure(f: impl FnMut(&K) -> V) -> Self

Returns a new ArrayMap where all the values are initialized to the same value

Panics

Panics if K::iter() returns anything other than N items or if K::index() returns a value >= N

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

Returns an iterator over all the items in the map. Note that the keys are owned.

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

Returns a mutable iterator over all the items in the map

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

Returns an iterator over all the keys in the map. Note that the keys are owned.

impl<K, V, const N: usize> ArrayMap<K, V, N>

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

Returns an iterator over all the values in the map

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

Returns a mutable iterator over all the values in the map

impl<K: Indexable, V, const N: usize> ArrayMap<K, Option<V>, N>

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

Collects an iterator of (K, Result<V, E>) into a Result<Self, E>

The trait FromIterator cannot be implemented for Result like it is on a Vec because of the orphan rules.

Trait Implementations

impl<K, V, const N: usize> AsMut<[V; N]> for ArrayMap<K, V, N>

fn as_mut(&mut self) -> &mut [V; N]

Performs the conversion.

impl<K, V, const N: usize> AsRef<[V; N]> for ArrayMap<K, V, N>

fn as_ref(&self) -> &[V; N]

Performs the conversion.

impl<K, V: Clone, const N: usize> Clone for ArrayMap<K, V, N>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Indexable, V: Debug, const N: usize> Debug for ArrayMap<K, V, N>

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

Formats the value using the given formatter.

impl<K: Indexable, V: Default, const N: usize> Default for ArrayMap<K, V, N>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K: Deserialize<'de> + Indexable, V: Deserialize<'de>, const N: usize> Deserialize<'de> for ArrayMap<K, V, N>

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

Deserialize this value from the given Serde deserializer.

impl<K: Indexable, const M: usize, const S: usize> From<&'_ ArrayMap<K, AtomicBool, M>> for ArraySet<K, S>

fn from(m: &ArrayMap<K, AtomicBool, M>) -> Self

Performs the conversion.

impl<K: Indexable, const M: usize, const S: usize> From<ArrayMap<K, bool, M>> for ArraySet<K, S>

fn from(m: ArrayMap<K, bool, M>) -> Self

Performs the conversion.

impl<K: Indexable, const M: usize, const S: usize> From<ArraySet<K, S>> for ArrayMap<K, bool, M>

fn from(s: ArraySet<K, S>) -> Self

Performs the conversion.

impl<K: Indexable, const M: usize, const S: usize> From<ArraySet<K, S>> for ArrayMap<K, AtomicBool, M>

fn from(s: ArraySet<K, S>) -> Self

Performs the conversion.

impl<K: Indexable, V, const N: usize> FromIterator<(K, V)> for ArrayMap<K, Option<V>, N>

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

Creates a value from an iterator.

impl<K: Indexable, V, const N: usize> Index<K> for ArrayMap<K, V, N>

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<K: Indexable, V, const N: usize> IndexMut<K> for ArrayMap<K, V, N>

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

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

impl<K: Indexable, V, const N: usize> IntoIterator for ArrayMap<K, V, N>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = Zip<K::Iter, IntoIter<V, N>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V: PartialEq, const N: usize> PartialEq<ArrayMap<K, V, N>> for ArrayMap<K, V, N>

fn eq(&self, other: &Self) -> bool

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

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

This method tests for !=.

impl<K: Serialize + Indexable, V: Serialize, const N: usize> Serialize for ArrayMap<K, V, N>

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

Serialize this value into the given Serde serializer.

impl<K, V: Copy, const N: usize> Copy for ArrayMap<K, V, N>

impl<K, V: Eq, const N: usize> Eq for ArrayMap<K, V, N>