Struct specs::storage::PairedStorage

pub struct PairedStorage<'rf, 'st: 'rf, C, S, B, Restrict> { /* fields omitted */ }

Pairs a storage with an index, meaning that the index is guaranteed to exist as long as the PairedStorage<C, S> exists.

Implementations

impl<'rf, 'st, C, S, B, Restrict> PairedStorage<'rf, 'st, C, S, B, Restrict> where
    C: Component,
    S: Borrow<C::Storage>,
    B: Borrow<BitSet>, 

pub fn get_unchecked(&self) -> &C

Gets the component related to the current entry without checking whether the storage has it or not.

impl<'rf, 'st, C, S, B, Restrict> PairedStorage<'rf, 'st, C, S, B, Restrict> where
    C: Component,
    S: BorrowMut<C::Storage>,
    B: Borrow<BitSet>, 

pub fn get_mut_unchecked(&mut self) -> &'_ mut C

Gets the component related to the current entry without checking whether the storage has it or not.

impl<'rf, 'st, C, S, B, Restrict> PairedStorage<'rf, 'st, C, S, B, Restrict> where
    C: Component,
    S: Borrow<C::Storage>,
    B: Borrow<BitSet>,
    Restrict: ImmutableAliasing, 

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

Attempts to get the component related to the entity.

Functions similar to the normal Storage::get implementation.

This only works for non-parallel or immutably parallel RestrictedStorage.

impl<'rf, 'st, C, S, B> PairedStorage<'rf, 'st, C, S, B, SequentialRestriction> where
    C: Component,
    S: BorrowMut<C::Storage>,
    B: Borrow<BitSet>, 

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

Attempts to get the component related to the entity mutably.

Functions similar to the normal Storage::get_mut implementation.

This only works if this is a non-parallel RestrictedStorage, otherwise you could access the same component mutably in two different threads.