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

Stores components for entities backed by a Vec.

Implementations§

source§

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

source

pub fn new() -> Self

Creates a new empty ComponentVec.

source

pub fn clear(&mut self)

Clears all components from the ComponentVec.

source§

impl<Idx, T> ComponentVec<Idx, T>
where Idx: ArenaIndex,

source

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.

source

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

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

source

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.

source

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§

source§

impl<Idx: Clone, T: Clone> Clone for ComponentVec<Idx, T>

source§

fn clone(&self) -> ComponentVec<Idx, T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<Idx, T> Index<Idx> for ComponentVec<Idx, T>
where Idx: ArenaIndex,

§

type Output = T

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl<Idx, T> IndexMut<Idx> for ComponentVec<Idx, T>
where Idx: ArenaIndex,

source§

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

Performs the mutable indexing (container[index]) operation. Read more
source§

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

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<Idx, T> Eq for ComponentVec<Idx, T>
where T: Eq,

source§

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

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

source§

impl<Idx, T> Sync for ComponentVec<Idx, T>
where T: Send,

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

Auto Trait Implementations§

§

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

§

impl<Idx, T> RefUnwindSafe for ComponentVec<Idx, T>
where T: RefUnwindSafe,

§

impl<Idx, T> Unpin for ComponentVec<Idx, T>
where T: Unpin,

§

impl<Idx, T> UnwindSafe for ComponentVec<Idx, T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.