Struct specs::storage::RestrictedStorage
source · pub struct RestrictedStorage<'rf, C, S> { /* private fields */ }
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().0 < 5 {
// Get a mutable reference now.
let mut mutable = comps.get_mut();
mutable.0 += 1;
}
}
}
}
Trait Implementations§
source§impl<'rf, C, S> Join for &'rf RestrictedStorage<'rf, C, S>where
C: Component,
S: Borrow<C::Storage>,
impl<'rf, C, S> Join for &'rf RestrictedStorage<'rf, C, S>where C: Component, S: Borrow<C::Storage>,
§type Type = PairedStorageRead<'rf, C>
type Type = PairedStorageRead<'rf, C>
Type of joined components.
§type Value = (&'rf <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
type Value = (&'rf <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
Type of joined storages.
source§unsafe fn open(self) -> (Self::Mask, Self::Value)
unsafe fn open(self) -> (Self::Mask, Self::Value)
Open this join by returning the mask and the storages. Read more
source§unsafe fn get(value: &mut Self::Value, id: Index) -> Self::Type
unsafe fn get(value: &mut Self::Value, id: Index) -> Self::Type
Get a joined component value by a given index. Read more
source§fn join(self) -> JoinIter<Self> ⓘwhere
Self: Sized,
fn join(self) -> JoinIter<Self> ⓘwhere Self: Sized,
Create a joined iterator over the contents.
source§fn is_unconstrained() -> bool
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
to go through all indices which is usually not what
is wanted and will kill performance.source§impl<'rf, C, S> Join for &'rf mut RestrictedStorage<'rf, C, S>where
C: Component,
S: BorrowMut<C::Storage>,
C::Storage: SharedGetMutStorage<C>,
impl<'rf, C, S> Join for &'rf mut RestrictedStorage<'rf, C, S>where C: Component, S: BorrowMut<C::Storage>, C::Storage: SharedGetMutStorage<C>,
§type Type = PairedStorageWriteShared<'rf, C>
type Type = PairedStorageWriteShared<'rf, C>
Type of joined components.
§type Value = SharedGetOnly<'rf, C, <C as Component>::Storage>
type Value = SharedGetOnly<'rf, C, <C as Component>::Storage>
Type of joined storages.
source§unsafe fn open(self) -> (Self::Mask, Self::Value)
unsafe fn open(self) -> (Self::Mask, Self::Value)
Open this join by returning the mask and the storages. Read more
source§unsafe fn get(value: &mut Self::Value, id: Index) -> Self::Type
unsafe fn get(value: &mut Self::Value, id: Index) -> Self::Type
Get a joined component value by a given index. Read more
source§fn join(self) -> JoinIter<Self> ⓘwhere
Self: Sized,
fn join(self) -> JoinIter<Self> ⓘwhere Self: Sized,
Create a joined iterator over the contents.
source§fn is_unconstrained() -> bool
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
to go through all indices which is usually not what
is wanted and will kill performance.source§impl<'rf, C, S> LendJoin for &'rf RestrictedStorage<'rf, C, S>where
C: Component,
S: Borrow<C::Storage>,
impl<'rf, C, S> LendJoin for &'rf RestrictedStorage<'rf, C, S>where C: Component, S: Borrow<C::Storage>,
§type Value = (&'rf <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
type Value = (&'rf <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
Type of joined storages.
source§unsafe fn open(self) -> (Self::Mask, Self::Value)
unsafe fn open(self) -> (Self::Mask, Self::Value)
Open this join by returning the mask and the storages. Read more
source§unsafe fn get<'next>(
value: &'next mut Self::Value,
id: Index
) -> <Self as LendJoinඞType<'next>>::T
unsafe fn get<'next>( value: &'next mut Self::Value, id: Index ) -> <Self as LendJoinඞType<'next>>::T
Get a joined component value by a given index. Read more
source§fn lend_join(self) -> JoinLendIter<Self>where
Self: Sized,
fn lend_join(self) -> JoinLendIter<Self>where Self: Sized,
Create a joined lending iterator over the contents.
source§fn maybe(self) -> MaybeJoin<Self>where
Self: Sized,
fn maybe(self) -> MaybeJoin<Self>where Self: Sized,
Returns a structure that implements
Join
/LendJoin
/MaybeJoin
if the
contained T
does and that yields all indices, returning None
for all
missing elements and Some(T)
for found elements. Read moresource§fn is_unconstrained() -> bool
fn is_unconstrained() -> bool
If this
LendJoin
typically returns all indices in the mask, then
iterating over only it or combined with other joins that are also
dangerous will cause the JoinLendIter
to go through all indices which
is usually not what is wanted and will kill performance.source§impl<'rf, C, S> LendJoin for &'rf mut RestrictedStorage<'rf, C, S>where
C: Component,
S: BorrowMut<C::Storage>,
impl<'rf, C, S> LendJoin for &'rf mut RestrictedStorage<'rf, C, S>where C: Component, S: BorrowMut<C::Storage>,
§type Value = (&'rf mut <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
type Value = (&'rf mut <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
Type of joined storages.
source§unsafe fn open(self) -> (Self::Mask, Self::Value)
unsafe fn open(self) -> (Self::Mask, Self::Value)
Open this join by returning the mask and the storages. Read more
source§unsafe fn get<'next>(
value: &'next mut Self::Value,
id: Index
) -> <Self as LendJoinඞType<'next>>::T
unsafe fn get<'next>( value: &'next mut Self::Value, id: Index ) -> <Self as LendJoinඞType<'next>>::T
Get a joined component value by a given index. Read more
source§fn lend_join(self) -> JoinLendIter<Self>where
Self: Sized,
fn lend_join(self) -> JoinLendIter<Self>where Self: Sized,
Create a joined lending iterator over the contents.
source§fn maybe(self) -> MaybeJoin<Self>where
Self: Sized,
fn maybe(self) -> MaybeJoin<Self>where Self: Sized,
Returns a structure that implements
Join
/LendJoin
/MaybeJoin
if the
contained T
does and that yields all indices, returning None
for all
missing elements and Some(T)
for found elements. Read moresource§fn is_unconstrained() -> bool
fn is_unconstrained() -> bool
If this
LendJoin
typically returns all indices in the mask, then
iterating over only it or combined with other joins that are also
dangerous will cause the JoinLendIter
to go through all indices which
is usually not what is wanted and will kill performance.source§impl<'rf, C, S> ParJoin for &'rf RestrictedStorage<'rf, C, S>where
C: Component,
S: Borrow<C::Storage>,
C::Storage: Sync,
impl<'rf, C, S> ParJoin for &'rf RestrictedStorage<'rf, C, S>where C: Component, S: Borrow<C::Storage>, C::Storage: Sync,
§type Type = PairedStorageRead<'rf, C>
type Type = PairedStorageRead<'rf, C>
Type of joined components.
§type Value = (&'rf <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
type Value = (&'rf <C as Component>::Storage, &'rf Fetch<'rf, EntitiesRes>, &'rf BitSet)
Type of joined storages.
source§unsafe fn open(self) -> (Self::Mask, Self::Value)
unsafe fn open(self) -> (Self::Mask, Self::Value)
Open this join by returning the mask and the storages. Read more
source§unsafe fn get(value: &Self::Value, id: Index) -> Self::Type
unsafe fn get(value: &Self::Value, id: Index) -> Self::Type
Get a joined component value by a given index. Read more
source§fn par_join(self) -> JoinParIter<Self>where
Self: Sized,
fn par_join(self) -> JoinParIter<Self>where Self: Sized,
Create a joined parallel iterator over the contents.
source§fn is_unconstrained() -> bool
fn is_unconstrained() -> bool
If this
LendJoin
typically returns all indices in the mask, then
iterating over only it or combined with other joins that are also
dangerous will cause the JoinLendIter
to go through all indices which
is usually not what is wanted and will kill performance.source§impl<'rf, C, S> ParJoin for &'rf mut RestrictedStorage<'rf, C, S>where
C: Component,
S: BorrowMut<C::Storage>,
C::Storage: Sync + SharedGetMutStorage<C> + DistinctStorage,
impl<'rf, C, S> ParJoin for &'rf mut RestrictedStorage<'rf, C, S>where C: Component, S: BorrowMut<C::Storage>, C::Storage: Sync + SharedGetMutStorage<C> + DistinctStorage,
§type Type = PairedStorageWriteShared<'rf, C>
type Type = PairedStorageWriteShared<'rf, C>
Type of joined components.
§type Value = SharedGetOnly<'rf, C, <C as Component>::Storage>
type Value = SharedGetOnly<'rf, C, <C as Component>::Storage>
Type of joined storages.
source§unsafe fn open(self) -> (Self::Mask, Self::Value)
unsafe fn open(self) -> (Self::Mask, Self::Value)
Open this join by returning the mask and the storages. Read more
source§unsafe fn get(value: &Self::Value, id: Index) -> Self::Type
unsafe fn get(value: &Self::Value, id: Index) -> Self::Type
Get a joined component value by a given index. Read more
source§fn par_join(self) -> JoinParIter<Self>where
Self: Sized,
fn par_join(self) -> JoinParIter<Self>where Self: Sized,
Create a joined parallel iterator over the contents.
source§fn is_unconstrained() -> bool
fn is_unconstrained() -> bool
If this
LendJoin
typically returns all indices in the mask, then
iterating over only it or combined with other joins that are also
dangerous will cause the JoinLendIter
to go through all indices which
is usually not what is wanted and will kill performance.impl<'rf, C, S> RepeatableLendGet for &'rf RestrictedStorage<'rf, C, S>where C: Component, S: Borrow<C::Storage>,
impl<'rf, C, S> RepeatableLendGet for &'rf mut RestrictedStorage<'rf, C, S>where C: Component, S: BorrowMut<C::Storage>,
Auto Trait Implementations§
impl<'rf, C, S> !RefUnwindSafe for RestrictedStorage<'rf, C, S>
impl<'rf, C, S> Send for RestrictedStorage<'rf, C, S>where C: Send, S: Send,
impl<'rf, C, S> Sync for RestrictedStorage<'rf, C, S>where C: Sync, S: Sync,
impl<'rf, C, S> Unpin for RestrictedStorage<'rf, C, S>where C: Unpin, S: Unpin,
impl<'rf, C, S> !UnwindSafe for RestrictedStorage<'rf, C, S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more