[−][src]Struct oxygengine_core::ecs::storage::RestrictedStorage
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
impl<'rf, 'st, C, S, B, Restrict> Join for &'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> where
'st: 'rf,
B: Borrow<BitSet>,
C: Component,
S: Borrow<<C as Component>::Storage>,
[src]
'st: 'rf,
B: Borrow<BitSet>,
C: Component,
S: Borrow<<C as Component>::Storage>,
type Mask = &'rf BitSet
Type of joined bit mask.
type Type = PairedStorage<'rf, 'st, C, &'rf <C as Component>::Storage, &'rf BitSet, Restrict>
Type of joined components.
type Value = (&'rf <C as Component>::Storage, &'rf Fetch<'st, EntitiesRes>, &'rf BitSet)
Type of joined storages.
unsafe fn open(
self
) -> (<&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Mask, <&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value)
[src]
self
) -> (<&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Mask, <&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value)
unsafe fn get(
value: &mut <&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value,
id: u32
) -> <&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Type
[src]
value: &mut <&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value,
id: u32
) -> <&'rf RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Type
fn join(self) -> JoinIter<Self>ⓘ
[src]
fn maybe(self) -> MaybeJoin<Self>
[src]
fn is_unconstrained() -> bool
[src]
impl<'rf, 'st, C, S, B, Restrict> Join for &'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> where
'st: 'rf,
B: Borrow<BitSet>,
C: Component,
S: BorrowMut<<C as Component>::Storage>,
[src]
'st: 'rf,
B: Borrow<BitSet>,
C: Component,
S: BorrowMut<<C as Component>::Storage>,
type Mask = &'rf BitSet
Type of joined bit mask.
type Type = PairedStorage<'rf, 'st, C, &'rf mut <C as Component>::Storage, &'rf BitSet, Restrict>
Type of joined components.
type Value = (&'rf mut <C as Component>::Storage, &'rf Fetch<'st, EntitiesRes>, &'rf BitSet)
Type of joined storages.
unsafe fn open(
self
) -> (<&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Mask, <&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value)
[src]
self
) -> (<&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Mask, <&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value)
unsafe fn get(
value: &mut <&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value,
id: u32
) -> <&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Type
[src]
value: &mut <&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Value,
id: u32
) -> <&'rf mut RestrictedStorage<'rf, 'st, C, S, B, Restrict> as Join>::Type
fn join(self) -> JoinIter<Self>ⓘ
[src]
fn maybe(self) -> MaybeJoin<Self>
[src]
fn is_unconstrained() -> bool
[src]
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>
impl<'rf, 'st, C, S, B, Restrict> !Sync for RestrictedStorage<'rf, 'st, C, S, B, Restrict>
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,
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>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Any for T where
T: Any,
T: Any,
fn get_type_id(&self) -> TypeId
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Resource for T where
T: Any,
[src]
T: Any,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,