Struct SlotMap

pub struct SlotMap<K: Key, T> { /* private fields */ }

A dense, resizable array that supports generational indexing.

You can use the new_key macro to create a new key type to use. It is recommended to use different key types for different collections to avoid accidentally using a key from a different map.

Implementations

impl<K: Key, T> SlotMap<K, T>

pub fn new() -> Self

Creates a new empty container.

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

Adds a new value to the map and returns a new key that references it.

pub fn remove(&mut self, key: K) -> Option<T>

Removes a value from the map and returns it (if it existed). It is guaranteed that all future accesses with the removed key will return None.

pub fn clear(&mut self)

Removes all values from the slotmap.

pub fn retain_mut<F: FnMut(K, &mut T) -> bool>(&mut self, f: F)

Retains only the values for which the predicate returns true. For all retained values, any existing keys are still valid after this operation.

pub fn get(&self, key: K) -> Option<&T>

Get a reference to a value in the map.

pub fn get_mut(&mut self, key: K) -> Option<&mut T>

Get a mutable reference to a value in the map.

pub fn len(&self) -> usize

Get the number of values stored in the map.

pub fn is_empty(&self) -> bool

Checks if the map is currently empty.

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

Iterates over the keys and values currently stored in the map.

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

Mutably iterates over the keys and values currently stored in the map.

Trait Implementations

impl<K: Clone + Key, T: Clone> Clone for SlotMap<K, T>

fn clone(&self) -> SlotMap<K, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Key, T> Collect for SlotMap<K, T>

where Vec<usize>: 'static, usize: 'static, PhantomData<K>: 'static, T: Collect,

fn needs_trace() -> bool

As an optimization, if this type can never hold a Gc pointer and trace is unnecessary to call, you may implement this method and return false. The default implementation returns true, signaling that Collect::trace must be called.

fn trace(&self, cc: &Collection)

Must call Collect::trace on all held Gc pointers. If this type holds inner types that implement Collect, a valid implementation would simply call Collect::trace on all the held values to ensure this.

impl<K: Key, T> Default for SlotMap<K, T>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Key, T> IntoIterator for SlotMap<K, T>

type IntoIter = IntoIter<K, T>

Which kind of iterator are we turning this into?

type Item = (K, T)

The type of the elements being iterated over.

fn into_iter(self) -> IntoIter<K, T>

Creates an iterator from a value.