Struct IndexMap

pub struct IndexMap<K: MapIndex, V> { /* private fields */ }

It’s an array. Lmao.

Implementations

impl<V, K: MapIndex> IndexMap<K, V>

pub fn new() -> Self

Constructs an empty IndexMap.

pub fn get(&self, index: K) -> Option<&V>

Gets a reference to the value in slot index.

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

Gets a mutable reference to the value in slot index.

pub fn get_many_mut<const N: usize>( &mut self, indices: [K; N], ) -> Result<[&mut V; N], GetManyMutError>

Returns mutable references to many indices at once.

Returns an error if any index is out of bounds, or if the same index was passed twice.

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

Returns an iterator over the IndexMap.

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

Returns an iterator that allows modifying each value.

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

Returns an iterator over all keys in the IndexMap.

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

Inserts a new item into the IndexMap, returning the key associated with it.

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

Replaces a value in the IndexMap, returning the old value.

Trait Implementations

impl<K: Clone + MapIndex, V: Clone> Clone for IndexMap<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + MapIndex, V: Debug> Debug for IndexMap<K, V>

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

Formats the value using the given formatter.

impl<K: MapIndex, V> Default for IndexMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K: MapIndex, V> Index<K> for IndexMap<K, V>

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<K: MapIndex, V> IndexMut<K> for IndexMap<K, V>

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

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

impl<K: PartialEq + MapIndex, V: PartialEq> PartialEq for IndexMap<K, V>

fn eq(&self, other: &IndexMap<K, V>) -> 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: Eq + MapIndex, V: Eq> Eq for IndexMap<K, V>

impl<K: MapIndex, V> StructuralPartialEq for IndexMap<K, V>