Struct OrdinalTotalMap 

pub struct OrdinalTotalMap<T, V> { /* private fields */ }

Map implementation where all values must be initialized at creation.

This version of map allocates values on the heap in a single contiguous block. For a version that doesn’t require heap allocation, see InitArrayMap.

Implementations

impl<K: Ordinal, V> OrdinalTotalMap<K, V>

pub fn try_new<E>(init: impl FnMut(K) -> Result<V, E>) -> Result<Self, E>

Create a new map by initializing each value with a function.

pub fn new(init: impl FnMut(K) -> V) -> Self

Create a new map by initializing each value with a function.

pub const fn len(&self) -> usize

Returns the number of elements in the map, which is always equal to K::ORDINAL_SIZE.

pub const fn is_empty(&self) -> bool

Return true if the map container no elements. This is only if <K> is empty.

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

Returns a reference to the value corresponding to the key.

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

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

pub fn keys(&self) -> OrdinalValues<K>

Iterate keys of the map, which is equivalent to iterating all possible values of K.

pub fn into_keys(self) -> OrdinalValues<K>

Iterate values of the map, which is equivalent to iterating all possible values of K.

pub fn values<'a>(&'a self) -> Iter<'a, V>

Iterate values of the map.

pub fn values_mut<'a>(&'a mut self) -> IterMut<'a, V>

Iterate mutable references to values of the map.

pub fn into_values(self) -> Box<[V]>

Obtain the values from the map.

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

Iterate over the map.

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

Iterate over the map mutably.

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

Insert a value into the map, returning the previous value.

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Ordinal + Debug, V: Debug> Debug for OrdinalTotalMap<K, V>

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

Formats the value using the given formatter.

impl<K: Ordinal, V: Default> Default for OrdinalTotalMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, K: Ordinal, V> Index<&'a K> for OrdinalTotalMap<K, V>

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, K: Ordinal, V> IndexMut<&'a K> for OrdinalTotalMap<K, V>

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

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

impl<K: Ordinal, V> IntoIterator for OrdinalTotalMap<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<'a, K: Ordinal, V> IntoIterator for &'a OrdinalTotalMap<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.