Struct linear_collections::ArrayMap

pub struct ArrayMap<K: Eq, V: Sized + PartialEq, const LENGTH: usize> { /* private fields */ }

Implementations

impl<K: Eq, V: Sized + PartialEq, const LENGTH: usize> ArrayMap<K, V, LENGTH>

pub const unsafe fn new_unchecked( array: [(K, V); LENGTH] ) -> ArrayMap<K, V, LENGTH>

Creates a new ArrayMap from the provided array: use this if you know for a fact that each key provided is unique.

Don’t be afraid by the unsafe marker: improper use of this method will NOT create memory unsafety, but will result in every identical key beyond the first never getting accessed as LinearMaps short circuit on the first matching key.

pub const fn len(&self) -> usize

Returns the number of items in this ArrayMap

pub const fn is_empty(&self) -> bool

Returns true if the store is empty, false otherwise.

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

Replaces a values all key value pairs matching an element from iter with that element from iter.

for example: [(A,1), (B, 2)].merge([(A,1), (B, 2’), (C, 2), (D, 3)].into_iter()) will yield a map: [(A, 1), (B, 2’)]

Trait Implementations

impl<K: Clone + Eq, V: Clone + Sized + PartialEq, const LENGTH: usize> Clone for ArrayMap<K, V, LENGTH>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Eq, V: Sized + PartialEq, const LENGTH: usize> LinearMap<K, V> for ArrayMap<K, V, LENGTH>

type Backing = [(K, V); LENGTH]

fn as_slice(&self) -> &[(K, V)]

The keys and values of the map.

fn into_inner(self) -> Self::Backing

Consumes self, returning the underlying store.

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

Returns true if this map contains the given key. False otherwise.

fn contains_value(&self, value: &V) -> bool

Returns true if this map contains a given value. False otherwise.

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

Gets a reference with the associated key. Will return None if that i key is not in the map.

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

Gets a mutable reference with the associated key. Will return None if that key is not in the map.

fn nth_value<'a>(&'a self, index: usize) -> Option<&'a V>

where K: 'a,

Gets a reference to the nth value in the map. Will return None if index is out of bounds.

fn nth_value_mut<'a>(&'a mut self, index: usize) -> Option<&'a mut V>

where K: 'a,

Gets a reference to the nth value in the map. Will return None if index is out of bounds.

fn nth_key<'a>(&'a self, index: usize) -> Option<&'a K>

where V: 'a,

Gets a reference to the nth value in the map. Will return None if index is out of bounds.

fn nth_key_mut<'a>(&'a mut self, index: usize) -> Option<&'a mut K>

where V: 'a,

Gets a reference to the nth key in the map. Will return None if index is out of bounds.

fn replace(&mut self, key: &K, value: V)

Searches for a key == key in the map. If it is present replaces its value with “value”. If not, it does nothing.

impl<K: Copy + Eq, V: Copy + Sized + PartialEq, const LENGTH: usize> Copy for ArrayMap<K, V, LENGTH>