Struct EntityMap 

pub struct EntityMap<E: Entity, V> { /* private fields */ }

A Vec-backed map keyed by EntityId<E>.

Implementations

impl<E: Entity, V> EntityMap<E, V>

pub fn new() -> Self

Creates an empty EntityMap.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty EntityMap with space for at least capacity values.

pub fn into_entity_vec(self) -> EntityVec<E, Option<V>>

Cheap conversion to an EntityVec<E, Option<V>>

pub fn len(&self) -> usize

Returns the number of stored key-value pairs.

pub fn capacity(&self) -> usize

Returns the capacity of the backing storage.

pub fn is_empty(&self) -> bool

Returns true if the map contains no values.

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

Reserves capacity for at least additional more values.

pub fn shrink_to_fit(&mut self)

Shrinks the backing vector to fit the highest occupied entity ID.

pub fn contains_key(&self, entity_id: EntityId<E>) -> bool

Returns true if entity_id is present in the map.

pub fn get(&self, entity_id: EntityId<E>) -> Option<&V>

Returns the value for entity_id, or None if not present.

pub fn get_mut(&mut self, entity_id: EntityId<E>) -> Option<&mut V>

Returns the value for entity_id mutably, or None if not present.

pub fn insert(&mut self, entity_id: EntityId<E>, value: V) -> Option<V>

Inserts value for entity_id, returning the previous value if one existed.

pub fn get_or_insert(&mut self, entity_id: EntityId<E>, value: V) -> &mut V

Returns the value for entity_id, inserting value if it is not already present.

pub fn get_or_insert_with<F>(&mut self, entity_id: EntityId<E>, f: F) -> &mut V

where F: FnOnce() -> V,

Returns the value for entity_id, inserting a value from f if it is not already present.

pub fn remove(&mut self, entity_id: EntityId<E>) -> Option<V>

Removes and returns the value for entity_id, if present.

pub fn clear(&mut self)

Clears the map, removing all key-value pairs.

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

Returns an iterator over (EntityId<E>, &V) pairs.

Trait Implementations

impl<E: Clone + Entity, V: Clone> Clone for EntityMap<E, V>

fn clone(&self) -> EntityMap<E, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Entity, V: Debug> Debug for EntityMap<E, V>

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

Formats the value using the given formatter.

impl<E: Entity, V> Default for EntityMap<E, V>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Entity, V> Extend<(EntityId<E>, V)> for EntityMap<E, V>

fn extend<I: IntoIterator<Item = (EntityId<E>, V)>>(&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<E: Entity, V> FromIterator<(EntityId<E>, V)> for EntityMap<E, V>

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

Creates a value from an iterator.

impl<'a, E: Entity, V> IntoIterator for &'a EntityMap<E, V>

type Item = (EntityId<E>, &'a V)

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<E: PartialEq + Entity, V: PartialEq> PartialEq for EntityMap<E, V>

fn eq(&self, other: &EntityMap<E, 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<E: Eq + Entity, V: Eq> Eq for EntityMap<E, V>

impl<E: Entity, V> StructuralPartialEq for EntityMap<E, V>