Struct specs::storage::DerefFlaggedStorage

pub struct DerefFlaggedStorage<C, T = DenseVecStorage<C>> { /* private fields */ }

Wrapper storage that tracks modifications, insertions, and removals of components through an EventChannel, in a similar manner to FlaggedStorage.

Unlike FlaggedStorage, this storage uses a wrapper type for mutable accesses that only emits modification events when the component is actually used mutably. This means that simply performing a mutable join or calling WriteStorage::get_mut will not, by itself, trigger a modification event.

Trait Implementations

impl<C, T> Default for DerefFlaggedStorage<C, T>where T: TryDefault,

fn default() -> Self

Returns the “default value” for a type.

impl<C, T> Tracked for DerefFlaggedStorage<C, T>

fn channel(&self) -> &EventChannel<ComponentEvent>

Event channel tracking modified/inserted/removed components.

fn channel_mut(&mut self) -> &mut EventChannel<ComponentEvent>

Mutable event channel tracking modified/inserted/removed components.

fn set_event_emission(&mut self, emit: bool)

Controls the events signal emission. When this is set to false the events modified/inserted/removed are not emitted.

fn event_emission(&self) -> bool

Returns the actual state of the event emission.

impl<C: Component, T: UnprotectedStorage<C>> UnprotectedStorage<C> for DerefFlaggedStorage<C, T>

type AccessMut<'a> = FlaggedAccessMut<'a, <T as UnprotectedStorage<C>>::AccessMut<'a>, C> where T: 'a

The wrapper through with mutable access of a component is performed.

unsafe fn clean<B>(&mut self, has: B)where B: BitSetLike,

Clean the storage given a bitset with bits set for valid indices dropping all existing components.

unsafe fn get(&self, id: Index) -> &C

Gets a shared reference to the data associated with an Index.

unsafe fn get_mut(&mut self, id: Index) -> Self::AccessMut<'_>

Gets mutable access to the the data associated with an Index.

unsafe fn insert(&mut self, id: Index, comp: C)

Inserts new data for a given Index.

unsafe fn remove(&mut self, id: Index) -> C

Removes the data associated with an Index.

unsafe fn drop(&mut self, id: Index)

Drops the data associated with an Index. This could be used when a more efficient implementation for it exists than remove when the data is no longer needed. Defaults to simply calling remove.