Struct StorageWrapper

pub struct StorageWrapper<'a, T, D> { /* private fields */ }

A wrapper around the masked storage and the generations vector. Can be used for safe lookup of components, insertions and removes. This is what World::read/write fetches for the user.

Implementations

impl<'a, T, D> StorageWrapper<'a, T, D>

pub fn new(data: D, entities: Ref<'a, Entities>) -> Self

impl<'a, T, D> StorageWrapper<'a, T, D>

where T: Component, D: Deref<Target = MaskedStorage<T>>,

pub fn fetched_entities(&self) -> &Entities

Returns the Entities resource fetched by this storage. This does not have anything to do with the components inside. You only want to use this when implementing additional methods for Storage via an extension trait.

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

Tries to read the data associated with an Entity.

pub fn count(&self) -> usize

Computes the number of elements this Storage contains by counting the bits in the bit set. This operation will never be performed in constant time.

pub fn is_empty(&self) -> bool

Checks whether this Storage is empty. This operation is very cheap.

pub fn contains(&self, e: Entity) -> bool

Returns true if the storage has a component for this entity, and that entity is alive.

pub fn mask(&self) -> &BitSet

Returns a reference to the bitset of this storage which allows filtering by the component type without actually getting the component.

pub fn not(&self) -> AntiStorage<'_>

impl<'a, T, D> StorageWrapper<'a, T, D>

where T: Component, D: DerefMut<Target = MaskedStorage<T>>,

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

Tries to mutate the data associated with an Entity.

pub fn insert( &mut self, entity: Entity, component: T, ) -> Result<Option<T>, Error>

Inserts new data for a given Entity. Returns the result of the operation as a InsertResult<T>

If a component already existed for the given Entity, then it will be overwritten with the new component. If it did overwrite, then the result will contain Some(T) where T is the previous component.

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

Removes the data associated with an Entity.

pub fn clear(&mut self)

Clears the contents of the storage.

pub fn drain(&mut self) -> Drain<'_, T>

Creates a draining storage wrapper which can be .joined to get a draining iterator.

Trait Implementations

impl<'a, 'e, T, D> Join for &'a StorageWrapper<'e, T, D>

where T: Component, D: Deref<Target = MaskedStorage<T>>,

type Mask = &'a BitSet

Type of joined bit mask.

type Type = &'a T

Type of joined components.

type Value = &'a <T as Component>::Storage

Type of joined storages.

unsafe fn open(self) -> (Self::Mask, Self::Value)

Open this join by returning the mask and the storages.

unsafe fn get(v: &mut Self::Value, i: Index) -> &'a T

Get a joined component value by a given index.

fn join(self) -> JoinIter<Self>

where Self: Sized,

Create a joined iterator over the contents.

fn maybe(self) -> MaybeJoin<Self>

where Self: Sized,

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

impl<'a, 'e, T, D> Join for &'a mut StorageWrapper<'e, T, D>

where T: Component, D: DerefMut<Target = MaskedStorage<T>>,

type Mask = &'a BitSet

Type of joined bit mask.

type Type = &'a mut T

Type of joined components.

type Value = &'a <T as Component>::Storage

Type of joined storages.

unsafe fn open(self) -> (Self::Mask, Self::Value)

Open this join by returning the mask and the storages.

unsafe fn get(v: &mut Self::Value, i: Index) -> &'a mut T

Get a joined component value by a given index.

fn join(self) -> JoinIter<Self>

where Self: Sized,

Create a joined iterator over the contents.

fn maybe(self) -> MaybeJoin<Self>

where Self: Sized,

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

impl<'a, 'e, T, D> Not for &'a StorageWrapper<'e, T, D>

where T: Component, D: Deref<Target = MaskedStorage<T>>,

type Output = AntiStorage<'a>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<'a, 'e, T, D> ParJoin for &'a StorageWrapper<'e, T, D>

where T: Component, D: Deref<Target = MaskedStorage<T>>, T::Storage: Sync,

fn par_join(self) -> JoinParIter<Self>

where Self: Sized,

impl<'a, 'e, T, D> ParJoin for &'a mut StorageWrapper<'e, T, D>

where T: Component, D: DerefMut<Target = MaskedStorage<T>>, T::Storage: Sync + DistinctStorage,

fn par_join(self) -> JoinParIter<Self>

where Self: Sized,

impl<'a, T: Component, D> DistinctStorage for StorageWrapper<'a, T, D>

where T::Storage: DistinctStorage,