Struct EntityVec 

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

A Vec-backed collection indexed by EntityId<E>.

Implementations

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

pub fn new() -> Self

Creates an empty EntityVec.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty EntityVec with space for at least capacity items.

pub fn len(&self) -> usize

Returns the number of values stored.

pub fn capacity(&self) -> usize

Returns the capacity of the backing vector.

pub fn is_empty(&self) -> bool

Returns true if no values are stored.

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 its length.

pub fn push(&mut self, value: V)

Appends value to the end of the vector.

pub fn pop(&mut self) -> Option<V>

Removes and returns the last value, or None if empty.

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

Returns the value for entity_id, or None if this vector is not long enough.

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

Returns the mutable value for entity_id, or None if this vector is not long enough.

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

Returns the last value, or None if empty.

pub fn last_mut(&mut self) -> Option<&mut V>

Returns the last value mutably, or None if empty.

pub fn as_slice(&self) -> &[V]

Returns the backing slice.

pub fn as_mut_slice(&mut self) -> &mut [V]

Returns the backing slice mutably.

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

Returns an iterator over the stored values.

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

Returns a mutable iterator over the stored values.

pub fn clear(&mut self)

Clears the vector, removing all values.

pub fn truncate(&mut self, len: usize)

Truncates the vector to len items.

pub fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = V>,

Extends the vector with values from iter, assigning contiguous IDs to new items.

pub fn resize(&mut self, new_len: usize, value: V)

where V: Clone,

Resizes the vector to new_len, cloning value as needed.

pub fn resize_with<F>(&mut self, new_len: usize, f: F)

where F: FnMut() -> V,

Resizes the vector to new_len, generating values with f as needed.

pub fn contains(&self, value: &V) -> bool

where V: PartialEq,

Returns true if the vector contains value.

pub fn into_vec(self) -> Vec<V>

Consumes the EntityVec and returns the backing Vec.

Trait Implementations

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

fn clone(&self) -> EntityVec<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 EntityVec<E, V>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<E: Entity, V> Extend<V> for EntityVec<E, V>

fn extend<I: IntoIterator<Item = 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> From<EntityVec<E, V>> for Vec<V>

fn from(value: EntityVec<E, V>) -> Self

Converts to this type from the input type.

impl<E: Entity, V> From<Vec<V>> for EntityVec<E, V>

fn from(data: Vec<V>) -> Self

Converts to this type from the input type.

impl<E: Entity, V> FromIterator<V> for EntityVec<E, V>

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

Creates a value from an iterator.

impl<E: Hash + Entity, V: Hash> Hash for EntityVec<E, 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<E: Entity, V> Index<EntityId<E>> for EntityVec<E, V>

type Output = V

The returned type after indexing.

fn index(&self, index: EntityId<E>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<E: Entity, V> IndexMut<EntityId<E>> for EntityVec<E, V>

fn index_mut(&mut self, index: EntityId<E>) -> &mut Self::Output

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

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

type Item = &'a V

The type of the elements being iterated over.

type IntoIter = Iter<'a, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Item = &'a mut V

The type of the elements being iterated over.

type IntoIter = IterMut<'a, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<E: Entity, V> IntoIterator for EntityVec<E, V>

type Item = V

The type of the elements being iterated over.

type IntoIter = IntoIter<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 EntityVec<E, V>

fn eq(&self, other: &EntityVec<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 EntityVec<E, V>

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