Struct PrimaryMap

pub struct PrimaryMap<K, V>
where
    K: EntityRef,
{ /* private fields */ }

A primary mapping K -> V allocating dense entity references.

The PrimaryMap data structure uses the dense index space to implement a map with a vector.

A primary map contains the main definition of an entity, and it can be used to allocate new entity references with the push method.

There should only be a single PrimaryMap instance for a given EntityRef type, otherwise conflicting references will be created. Using unknown keys for indexing will cause a panic.

Note that PrimaryMap doesn’t implement Deref or DerefMut, which would allow &PrimaryMap<K, V> to convert to &[V]. One of the main advantages of PrimaryMap is that it only allows indexing with the distinct EntityRef key type, so converting to a plain slice would make it easier to use incorrectly. To make a slice of a PrimaryMap, use into_boxed_slice.

Implementations

impl<K, V> PrimaryMap<K, V>

where K: EntityRef,

pub fn new() -> Self

Create a new empty map.

pub fn with_capacity(capacity: usize) -> Self

Create a new empty map with the given capacity.

pub fn is_valid(&self, k: K) -> bool

Check if k is a valid key in the map.

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

Get the element at k if it exists.

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

Get the element at k if it exists, mutable version.

pub fn is_empty(&self) -> bool

Is this map completely empty?

pub fn len(&self) -> usize

Get the total number of entity references created.

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

Iterate over all the keys in this map.

pub fn values(&self) -> Iter<'_, V>

Iterate over all the values in this map.

pub fn values_mut(&mut self) -> IterMut<'_, V>

Iterate over all the values in this map, mutable edition.

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

Iterate over all the keys and values in this map.

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

Iterate over all the keys and values in this map, mutable edition.

pub fn clear(&mut self)

Remove all entries from this map.

pub fn next_key(&self) -> K

Get the key that will be assigned to the next pushed value.

pub fn push(&mut self, v: V) -> K

Append v to the mapping, assigning a new key which is returned.

pub fn last(&self) -> Option<&V>

Returns the last element that was inserted in the map.

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

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

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

Reserves the minimum capacity for exactly additional more elements to be inserted.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the PrimaryMap as much as possible.

pub fn into_boxed_slice(self) -> BoxedSlice<K, V>

Consumes this PrimaryMap and produces a BoxedSlice.

Trait Implementations

impl<K, V> Archive for PrimaryMap<K, V>

where K: EntityRef, Vec<V>: Archive, PhantomData<K>: Archive,

type Archived = ArchivedPrimaryMap<K, V>

The archived representation of this type.

type Resolver = PrimaryMapResolver<K, V>

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, resolver: Self::Resolver, out: *mut Self::Archived, )

Creates the archived version of this value at the given position and writes it to the given output.

impl<K, V: Clone> Clone for PrimaryMap<K, V>

where K: EntityRef + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V: Debug> Debug for PrimaryMap<K, V>

where K: EntityRef + Debug,

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

Formats the value using the given formatter.

impl<K, V> Default for PrimaryMap<K, V>

where K: EntityRef,

fn default() -> Self

Returns the “default value” for a type.

impl<__D: Fallible + ?Sized, K, V> Deserialize<PrimaryMap<K, V>, __D> for Archived<PrimaryMap<K, V>>

where K: EntityRef, Vec<V>: Archive, Archived<Vec<V>>: Deserialize<Vec<V>, __D>, PhantomData<K>: Archive, Archived<PhantomData<K>>: Deserialize<PhantomData<K>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<PrimaryMap<K, V>, __D::Error>

Deserializes using the given deserializer

impl<K, V> FromIterator<V> for PrimaryMap<K, V>

where K: EntityRef,

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = V>,

Creates a value from an iterator.

impl<K, V: Hash> Hash for PrimaryMap<K, V>

where K: EntityRef + Hash,

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<K, V> Index<K> for PrimaryMap<K, V>

where K: EntityRef,

Immutable indexing into an PrimaryMap. The indexed value must be in the map.

type Output = V

The returned type after indexing.

fn index(&self, k: K) -> &V

Performs the indexing (container[index]) operation.

impl<K, V> IndexMut<K> for PrimaryMap<K, V>

where K: EntityRef,

Mutable indexing into an PrimaryMap.

fn index_mut(&mut self, k: K) -> &mut V

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

impl<'a, K, V> IntoIterator for &'a PrimaryMap<K, V>

where K: EntityRef,

type Item = (K, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K, V> IntoIterator for &'a mut PrimaryMap<K, V>

where K: EntityRef,

type Item = (K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> IntoIterator for PrimaryMap<K, V>

where K: EntityRef,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V: PartialEq> PartialEq for PrimaryMap<K, V>

where K: EntityRef + PartialEq,

fn eq(&self, other: &PrimaryMap<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<__S: Fallible + ?Sized, K, V> Serialize<__S> for PrimaryMap<K, V>

where K: EntityRef, Vec<V>: Serialize<__S>, PhantomData<K>: Serialize<__S>,

fn serialize(&self, serializer: &mut __S) -> Result<Self::Resolver, __S::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl<K, V: Eq> Eq for PrimaryMap<K, V>

where K: EntityRef + Eq,

impl<K, V> StructuralPartialEq for PrimaryMap<K, V>

where K: EntityRef,