Struct ComponentVec

pub struct ComponentVec<Idx, T> { /* private fields */ }

Stores components for entities backed by a Vec.

Implementations

impl<Idx, T> ComponentVec<Idx, T>

pub fn new() -> Self

Creates a new empty ComponentVec.

pub fn clear(&mut self)

Clears all components from the ComponentVec.

impl<Idx, T> ComponentVec<Idx, T>

where Idx: ArenaIndex,

pub fn set(&mut self, index: Idx, component: T) -> Option<T>

Sets the component for the entity at index.

Returns the old component of the same entity if any.

pub fn unset(&mut self, index: Idx) -> Option<T>

Unsets the component for the entity at index and returns it if any.

pub fn get(&self, index: Idx) -> Option<&T>

Returns a shared reference to the component at the index if any.

Returns None if no component is stored under the index.

pub fn get_mut(&mut self, index: Idx) -> Option<&mut T>

Returns an exclusive reference to the component at the index if any.

Returns None if no component is stored under the index.

Trait Implementations

impl<Idx, T> Debug for ComponentVec<Idx, T>

where T: Debug,

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

Formats the value using the given formatter.

impl<Idx, T> Default for ComponentVec<Idx, T>

fn default() -> Self

Returns the “default value” for a type.

impl<Idx, T> Index<Idx> for ComponentVec<Idx, T>

where Idx: ArenaIndex,

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Idx, T> IndexMut<Idx> for ComponentVec<Idx, T>

where Idx: ArenaIndex,

fn index_mut(&mut self, index: Idx) -> &mut Self::Output

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

impl<Idx, T> PartialEq for ComponentVec<Idx, T>

where T: PartialEq,

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<Idx, T> Eq for ComponentVec<Idx, T>

where T: Eq,

impl<Idx, T> Send for ComponentVec<Idx, T>

where T: Send,

ComponentVec does not store Idx therefore it is Send without its bound.

impl<Idx, T> Sync for ComponentVec<Idx, T>

where T: Sync,

ComponentVec does not store Idx therefore it is Sync without its bound.