Struct IdMap

pub struct IdMap<T> { /* private fields */ }

A container that gives each item a unique id. Internally all elements are stored contiguously.

Implementations

impl<T> IdMap<T>

pub fn new() -> Self

Creates an empty IdMap<T>.

pub fn with_capacity(cap: usize) -> Self

Creates an IdMap<T> with the specified capacity.

pub fn clear(&mut self)

Removes all values from the map.

pub fn next_id(&self) -> Id

Returns the id that a subsequent call to insert() will produce.

pub fn len(&self) -> usize

Returns the number of id-value pairs in the map.

pub fn capacity(&self) -> usize

Returns the number of id-value pairs the map can hold before reallocating.

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

Resizes the map such that that capacity() >= cap.

pub fn shrink_to_fit(&mut self)

Resizes the map to minimize allocated memory.

pub fn as_set(&self) -> &IdSet

Returns a reference to the set of valid ids.

pub fn insert(&mut self, val: T) -> Id

Inserts a value into an empty slot in the map and returns its id.

pub fn insert_at(&mut self, id: Id, val: T) -> Option<T>

Inserts a value at a specific id, returning the old value if it existed.

pub fn remove(&mut self, id: Id) -> Option<T>

Removes an id from the map, returning its value if it was previously in the map.

pub fn get_or_insert(&mut self, id: Id, val: T) -> &mut T

If the id has a value, returns it, otherwise inserts a new value.

pub fn get_or_insert_with<F: FnOnce() -> T>(&mut self, id: Id, f: F) -> &mut T

If the id has a value, returns it, otherwise inserts a new value with the provided closure.

pub fn remove_set(&mut self, set: &IdSet)

Removes all ids in the set from the map.

pub fn retain<F: FnMut(Id, &T) -> bool>(&mut self, pred: F)

Remove all values not satisfying the predicate.

pub fn contains(&self, id: Id) -> bool

Returns true if the map contains a value for the specified id.

pub fn get(&self, id: Id) -> Option<&T>

Returns a reference to the value at the specified id if it is in the map.

pub fn get_mut(&mut self, id: Id) -> Option<&mut T>

Returns a mutable reference to the value at the specified id if it is in the map.

pub fn ids(&self) -> Ids<'_>

An iterator over ids, in increasing order.

pub fn values(&self) -> Values<'_, T>

An iterator over values, in order of increasing id.

pub fn values_mut(&mut self) -> ValuesMut<'_, T>

A mutable iterator over values, in order of increasing id.

pub fn iter(&self) -> Iter<'_, T>

An iterator over id-value pairs, in order of increasing id.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

A mutable iterator over id-value pairs, in order of increasing id.

pub fn into_iter(self) -> IntoIter<T>

A consuming iterator over id-value pairs, in order of increasing id.

Trait Implementations

impl<T: Clone> Clone for IdMap<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for IdMap<T>

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

Formats the value using the given formatter.

impl<T> Default for IdMap<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for IdMap<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Extend<T> for IdMap<T>

fn extend<I: IntoIterator<Item = 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> FromIterator<(usize, T)> for IdMap<T>

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

Creates a value from an iterator.

impl<T> FromIterator<T> for IdMap<T>

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

Creates a value from an iterator.

impl<T> Index<usize> for IdMap<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for IdMap<T>

fn index_mut(&mut self, id: Id) -> &mut Self::Output

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

impl<'a, T> IntoIterator for &'a IdMap<T>

type Item = (usize, &'a T)

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut IdMap<T>

type Item = (usize, &'a mut T)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for IdMap<T>

type Item = (usize, T)

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for IdMap<T>

fn eq(&self, other: &Self) -> 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<T: Eq> Eq for IdMap<T>