Struct specs::storage::RestrictedStorage [−][src]
pub struct RestrictedStorage<'rf, 'st: 'rf, C, S, B, Restrict> where
C: Component,
S: Borrow<C::Storage> + 'rf,
B: Borrow<BitSet> + 'rf, { /* fields omitted */ }
Expand description
Similar to a MaskedStorage
and a Storage
combined, but restricts usage
to only getting and modifying the components. That means it’s not possible
to modify the inner bitset so the iteration cannot be invalidated. In other
words, no insertion or removal is allowed.
Example Usage:
struct SomeComp(u32); impl Component for SomeComp { type Storage = VecStorage<Self>; } struct RestrictedSystem; impl<'a> System<'a> for RestrictedSystem { type SystemData = (Entities<'a>, WriteStorage<'a, SomeComp>); fn run(&mut self, (entities, mut some_comps): Self::SystemData) { for (entity, mut comps) in (&entities, &mut some_comps.restrict_mut()).join() { // Check if the reference is fine to mutate. if comps.get_unchecked().0 < 5 { // Get a mutable reference now. let mut mutable = comps.get_mut_unchecked(); mutable.0 += 1; } } } }
Trait Implementations
type Type = PairedStorage<'rf, 'st, C, &'rf C::Storage, &'rf BitSet, Restrict>
type Type = PairedStorage<'rf, 'st, C, &'rf C::Storage, &'rf BitSet, Restrict>
Type of joined components.
Open this join by returning the mask and the storages. Read more
Get a joined component value by a given index. Read more
Create a joined iterator over the contents.
Returns a Join
-able structure that yields all indices, returning
None
for all missing elements and Some(T)
for found elements. Read more
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. Read more
type Type = PairedStorage<'rf, 'st, C, &'rf mut C::Storage, &'rf BitSet, Restrict>
type Type = PairedStorage<'rf, 'st, C, &'rf mut C::Storage, &'rf BitSet, Restrict>
Type of joined components.
Type of joined storages.
Open this join by returning the mask and the storages. Read more
Get a joined component value by a given index. Read more
Create a joined iterator over the contents.
Returns a Join
-able structure that yields all indices, returning
None
for all missing elements and Some(T)
for found elements. Read more
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. Read more
impl<'rf, 'st: 'rf, C, S, B> ParJoin for &'rf mut RestrictedStorage<'rf, 'st, C, S, B, MutableParallelRestriction> where
C: Component,
S: BorrowMut<C::Storage> + 'rf,
B: Borrow<BitSet> + 'rf,
[src]
impl<'rf, 'st: 'rf, C, S, B> ParJoin for &'rf mut RestrictedStorage<'rf, 'st, C, S, B, MutableParallelRestriction> where
C: Component,
S: BorrowMut<C::Storage> + 'rf,
B: Borrow<BitSet> + 'rf,
[src]Create a joined parallel iterator over the contents.
Create a joined parallel iterator over the contents.
Auto Trait Implementations
impl<'rf, 'st, C, S, B, Restrict> !RefUnwindSafe for RestrictedStorage<'rf, 'st, C, S, B, Restrict>
impl<'rf, 'st, C, S, B, Restrict> Send for RestrictedStorage<'rf, 'st, C, S, B, Restrict> where
B: Send,
C: Send,
Restrict: Send,
S: Send,
impl<'rf, 'st, C, S, B, Restrict> Sync for RestrictedStorage<'rf, 'st, C, S, B, Restrict> where
B: Sync,
C: Sync,
Restrict: Sync,
S: Sync,
impl<'rf, 'st, C, S, B, Restrict> Unpin for RestrictedStorage<'rf, 'st, C, S, B, Restrict> where
B: Unpin,
C: Unpin,
Restrict: Unpin,
S: Unpin,
'st: 'rf,
impl<'rf, 'st, C, S, B, Restrict> !UnwindSafe for RestrictedStorage<'rf, 'st, C, S, B, Restrict>