Struct genesis::VecStorage

pub struct VecStorage<T> { /* fields omitted */ }

A storage type that stores components in a contiguous Vec.

Implementations

impl<T> VecStorage<T>

pub fn new(entities: Arc<RwLock<Entities>>, capacity: u32) -> Self

Create a new VecStorage with the specified initial capacity.

pub fn get(&self, entity: Entity) -> Option<&T>

Get a reference to the component associated with the given entity in self, if any.

pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T>

Get a mutable reference to the component associated with the given entity in self, if any.

pub fn set(
    &mut self,
    entity: Entity,
    data: T
) -> Result<Option<T>, NoSuchEntity>

Set the component for the given entity. Returns Err(NoSuchEntity) if the given entity doesn’t exist. Otherwise, returns Ok(data), where data is previous data evicted by this operation (if any).

pub fn remove_unchecked(&mut self, entity: Entity) -> Option<T>

Remove the component for the given entity. Returns the previous data associated with the given entity in self. Does not check if the entity exists; only use this if you know it exists, e.g. through invariants in your code or because you retrieved this in a loop iterating over all alive entities.

pub fn remove(&mut self, entity: Entity) -> Result<Option<T>, NoSuchEntity>

Remove the component for the given entity. Returns the previous data associated with the given entity in self.

pub fn clear(&mut self)

Remove the data stored in self for all entities.

Trait Implementations

impl<T: Debug> Debug for VecStorage<T>

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

Formats the value using the given formatter.