Struct MapStorage

pub struct MapStorage<T> { /* private fields */ }

A storage type based on a HashMap, intended for sparsely used components.

Implementations

impl<T> MapStorage<T>

pub fn new(entity_allocator: Arc<RwLock<Entities>>) -> Self

Create a new MapStorage.

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

Get a reference to the associated component for the given entity, if any.

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

Get a mutable reference to the associated component for the given entity, if any.

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

Set the component for the given entity. Returns Err(NoSuchEnitty) if the given entity doesn’t exist. Otherwise, returns the previous data stored in self for the given entity.

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 MapStorage<T>

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

Formats the value using the given formatter.