Struct ArenaMap

pub struct ArenaMap<IDX, V> { /* private fields */ }

A map from arena indexes to some other type. Space requirement is O(highest index).

Implementations

impl<T, V> ArenaMap<Idx<T>, V>

pub const fn new() -> Self

Creates a new empty map.

pub fn with_capacity(capacity: usize) -> Self

Create a new empty map with specific capacity.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the map.

pub fn clear(&mut self)

Clears the map, removing all elements.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the map as much as possible.

pub fn contains_idx(&self, idx: Idx<T>) -> bool

Returns whether the map contains a value for the specified index.

pub fn remove(&mut self, idx: Idx<T>) -> Option<V>

Removes an index from the map, returning the value at the index if the index was previously in the map.

pub fn insert(&mut self, idx: Idx<T>, t: V) -> Option<V>

Inserts a value associated with a given arena index into the map.

If the map did not have this index present, None is returned. Otherwise, the value is updated, and the old value is returned.

pub fn get(&self, idx: Idx<T>) -> Option<&V>

Returns a reference to the value associated with the provided index if it is present.

pub fn get_mut(&mut self, idx: Idx<T>) -> Option<&mut V>

Returns a mutable reference to the value associated with the provided index if it is present.

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

Returns an iterator over the values in the map.

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

Returns an iterator over mutable references to the values in the map.

pub fn iter(&self) -> impl DoubleEndedIterator<Item = (Idx<T>, &V)>

Returns an iterator over the arena indexes and values in the map.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (Idx<T>, &mut V)>

Returns an iterator over the arena indexes and values in the map.

pub fn entry(&mut self, idx: Idx<T>) -> Entry<'_, Idx<T>, V>

Gets the given key’s corresponding entry in the map for in-place manipulation.

Trait Implementations

impl<IDX: Clone, V: Clone> Clone for ArenaMap<IDX, V>

fn clone(&self) -> ArenaMap<IDX, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<IDX: Debug, V: Debug> Debug for ArenaMap<IDX, V>

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

Formats the value using the given formatter.

impl<T, V> Default for ArenaMap<Idx<V>, T>

fn default() -> Self

Returns the “default value” for a type.

impl<T, V> Extend<(Idx<V>, T)> for ArenaMap<Idx<V>, T>

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

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<T, V> FromIterator<(Idx<V>, T)> for ArenaMap<Idx<V>, T>

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

Creates a value from an iterator.

impl<IDX: Hash, V: Hash> Hash for ArenaMap<IDX, V>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, V> Index<Idx<V>> for ArenaMap<Idx<V>, T>

type Output = T

The returned type after indexing.

fn index(&self, idx: Idx<V>) -> &T

Performs the indexing (container[index]) operation.

impl<T, V> IndexMut<Idx<V>> for ArenaMap<Idx<V>, T>

fn index_mut(&mut self, idx: Idx<V>) -> &mut T

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

impl<T, V> IntoIterator for ArenaMap<Idx<T>, V>

type Item = (Idx<T>, V)

The type of the elements being iterated over.

type IntoIter = ArenaMapIter<Idx<T>, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<IDX: Ord, V: Ord> Ord for ArenaMap<IDX, V>

fn cmp(&self, other: &ArenaMap<IDX, V>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<IDX: PartialEq, V: PartialEq> PartialEq for ArenaMap<IDX, V>

fn eq(&self, other: &ArenaMap<IDX, 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<IDX: PartialOrd, V: PartialOrd> PartialOrd for ArenaMap<IDX, V>

fn partial_cmp(&self, other: &ArenaMap<IDX, V>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<IDX: Eq, V: Eq> Eq for ArenaMap<IDX, V>

impl<IDX, V> StructuralPartialEq for ArenaMap<IDX, V>