Struct goggles::masked::MaskedStorage

pub struct MaskedStorage<S: RawStorage> { /* fields omitted */ }

Wraps a RawStorage for some component with a BitSet mask to provide a safe, Join-able interface for component storage.

Implementations

impl<S: RawStorage> MaskedStorage<S>

pub fn mask(&self) -> &BitSet

pub fn raw_storage(&self) -> &S

pub fn raw_storage_mut(&mut self) -> &mut S

pub fn contains(&self, index: Index) -> bool

pub fn get(&self, index: Index) -> Option<&S::Item>

pub fn get_mut(&mut self, index: Index) -> Option<&mut S::Item>

pub fn get_or_insert_with(
    &mut self,
    index: Index,
    f: impl FnOnce() -> S::Item
) -> &mut S::Item

pub fn insert(&mut self, index: Index, v: S::Item) -> Option<S::Item>

pub fn update(&mut self, index: Index, v: S::Item) -> Option<S::Item> where
    S::Item: PartialEq, 

Update the value at this index only if it has changed.

This is useful when combined with FlaggedStorage, which keeps track of modified components. By using this method, you can avoid flagging changes unnecessarily when the new value of the component is equal to the old one.

pub fn remove(&mut self, index: Index) -> Option<S::Item>

pub fn guard(&mut self) -> GuardedJoin<'_, S>

Returns an IntoJoin type whose values are GuardedJoin wrappers.

A GuardedJoin wrapper does not automatically call RawStorage::get_mut, so it can be useful to avoid flagging modifications with a FlaggedStorage.

impl<S: DenseStorage> MaskedStorage<S>

pub fn as_slice(&self) -> &[S::Item]

pub fn as_mut_slice(&mut self) -> &mut [S::Item]

impl<S: TrackedStorage> MaskedStorage<S>

pub fn tracking_modified(&self) -> bool

pub fn modified_indexes(&self) -> &ModifiedBitSet

pub fn set_track_modified(&mut self, flag: bool)

pub fn mark_modified(&self, index: Index)

pub fn clear_modified(&mut self)

pub fn modified(&self) -> ModifiedJoin<'_, S>

Returns an IntoJoin type which joins over all the modified elements.

The items on the returned join are all Option<&S::Item>, removed elements will show up as None.

pub fn modified_mut(&mut self) -> ModifiedJoinMut<'_, S>

Returns an IntoJoin type which joins over all the modified elements mutably.

This is similar to MaskedStorage::modified, but returns mutable access to each item.

Trait Implementations

impl<S: RawStorage + Default> Default for MaskedStorage<S>

fn default() -> Self

Returns the "default value" for a type.

impl<S: RawStorage> Drop for MaskedStorage<S>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, S: RawStorage> Join for &'a MaskedStorage<S>

type Item = &'a S::Item

type Access = &'a S

type Mask = &'a BitSet

fn open(self) -> (Self::Mask, Self::Access)

unsafe fn get(access: &Self::Access, index: Index) -> Self::Item

Get a value out of the access type returned from open.

impl<'a, S: RawStorage> Join for &'a mut MaskedStorage<S>

type Item = &'a mut S::Item

type Access = &'a S

type Mask = &'a BitSet

fn open(self) -> (Self::Mask, Self::Access)

unsafe fn get(access: &Self::Access, index: Index) -> Self::Item

Get a value out of the access type returned from open.