Struct shipyard::ViewMut

pub struct ViewMut<'a, T> { /* fields omitted */ }

Exclusive view over a component storage.

Implementations

impl<T> ViewMut<'_, T>

pub fn inserted(&self) -> Inserted<&Self>

Wraps this view to be able to iterate inserted components.

pub fn modified(&self) -> Modified<&Self>

Wraps this view to be able to iterate modified components.

pub fn inserted_or_modified(&self) -> InsertedOrModified<&Self>

Wraps this view to be able to iterate inserted and modified components.

pub fn inserted_mut(&mut self) -> Inserted<&mut Self>

Wraps this view to be able to iterate inserted components.

pub fn modified_mut(&mut self) -> Modified<&mut Self>

Wraps this view to be able to iterate modified components.

pub fn inserted_or_modified_mut(&mut self) -> InsertedOrModified<&mut Self>

Wraps this view to be able to iterate inserted and modified components.

Methods from Deref<Target = SparseSet<T>>

pub fn as_slice(&self) -> &[T]

Returns a slice of all the components in this storage.

pub fn contains(&self, entity: EntityId) -> bool

Returns true if entity owns a component in this storage.

pub fn len(&self) -> usize

Returns the length of the storage.

pub fn is_empty(&self) -> bool

Returns true if the storage’s length is 0.

pub fn index_of(&self, entity: EntityId) -> Option<usize>

Returns the index of entity’s component in the dense and data vectors.
This index is only valid for this storage and until a modification happens.

pub unsafe fn index_of_unchecked(&self, entity: EntityId) -> usize

Returns the index of entity’s component in the dense and data vectors.
This index is only valid for this storage and until a modification happens.

Safety

entity has to own a component of this type.
The index is only valid until a modification occurs in the storage.

pub fn id_at(&self, index: usize) -> Option<EntityId>

Returns the EntityId at a given index.

pub fn remove(&mut self, entity: EntityId) -> Option<T> where
    T: 'static, 

Removes entity’s component from this storage.

pub fn delete(&mut self, entity: EntityId) -> bool where
    T: 'static, 

Deletes entity’s component from this storage.

pub fn is_inserted(&self, entity: EntityId) -> bool

Returns true if entity’s component was inserted since the last clear_inserted or clear_all_inserted call.
Returns false if entity does not have a component in this storage.

pub fn is_modified(&self, entity: EntityId) -> bool

Returns true if entity’s component was modified since the last clear_modified or clear_all_modified call.
Returns false if entity does not have a component in this storage.

pub fn is_inserted_or_modified(&self, entity: EntityId) -> bool

Returns true if entity’s component was inserted or modified since the last clear call.
Returns false if entity does not have a component in this storage.

pub fn deleted(&self) -> &[(EntityId, T)]

Returns the deleted components of a storage tracking deletion.

Panics

• Storage does not track deletion. Start tracking by calling track_deletion or track_all.

pub fn removed(&self) -> &[EntityId]

Returns the ids of removed components of a storage tracking removal.

Panics

• Storage does not track removal. Start tracking by calling track_removal or track_all.

pub fn removed_or_deleted(&self) -> impl Iterator<Item = EntityId> + '_

Returns the ids of removed or deleted components of a storage tracking removal and/or deletion.

Panics

• Storage does not track removal nor deletion. Start tracking by calling track_removal, track_deletion or track_all.

pub fn take_deleted(&mut self) -> Vec<(EntityId, T)>

Takes ownership of the deleted components of a storage tracking deletion.

Panics

• Storage does not track deletion. Start tracking by calling track_deletion or track_all.

pub fn take_removed(&mut self) -> Vec<EntityId>

Takes ownership of the ids of removed components of a storage tracking removal.

Panics

• Storage does not track removal. Start tracking by calling track_removal or track_all.

pub fn take_removed_and_deleted(
    &mut self
) -> (Vec<EntityId>, Vec<(EntityId, T)>)

Takes ownership of the removed and deleted components of a storage tracking removal and/or deletion.

Panics

• Storage does not track removal nor deletion. Start tracking by calling track_removal, track_deletion or track_all.

pub fn clear_inserted(&mut self, entity: EntityId)

Removes the inserted flag on entity’s component.

Panics

• Storage does not track insertion. Start tracking by calling track_insertion or track_all.

pub fn clear_all_inserted(&mut self)

Removes the inserted flag on all components of this storage.

Panics

• Storage does not track insertion. Start tracking by calling track_insertion or track_all.

pub fn clear_modified(&mut self, entity: EntityId)

Removes the modified flag on entity’s component.

Panics

• Storage does not track modification. Start tracking by calling track_modification or track_all.

pub fn clear_all_modified(&mut self)

Removes the modified flag on all components of this storage.

Panics

• Storage does not track modification. Start tracking by calling track_modification or track_all.

pub fn clear_inserted_and_modified(&mut self, entity: EntityId)

Removes the inserted and modified flags on entity’s component.

Panics

• Storage does not track insertion not modification. Start tracking by calling track_insertion, track_modification or track_all.

pub fn clear_all_inserted_and_modified(&mut self)

Removes the inserted and modified flags on all components of this storage.

Panics

• Storage does not track insertion not modification. Start tracking by calling track_insertion, track_modification or track_all.

pub fn track_insertion(&mut self) -> &mut Self

Flags components when they are inserted.
To check the flag use is_inserted, is_inserted_or_modified or iterate over the storage after calling inserted.
To clear the flag use clear_inserted or clear_all_inserted.

pub fn track_modification(&mut self) -> &mut Self

Flags components when they are modified. Will not flag components already flagged inserted.
To check the flag use is_modified, is_inserted_or_modified or iterate over the storage after calling modified.
To clear the flag use clear_modified or clear_all_modified.

pub fn track_deletion(&mut self) -> &mut Self

Stores components and their EntityId when they are deleted.
You can access them with deleted or removed_or_deleted.
You can clear them and get back a Vec with take_deleted or take_removed_and_deleted.

pub fn track_removal(&mut self) -> &mut Self

Stores EntityId of deleted components.
You can access them with removed or removed_or_deleted.
You can clear them and get back a Vec with take_removed or take_removed_and_deleted.

pub fn track_all(&mut self)

Flags component insertion, modification, deletion and removal.
Same as calling track_insertion, track_modification, track_deletion and track_removal.

pub fn is_tracking_insertion(&self) -> bool

Returns true if the storage tracks insertion.

pub fn is_tracking_modification(&self) -> bool

Returns true if the storage tracks modification.

pub fn is_tracking_deletion(&self) -> bool

Returns true if the storage tracks deletion.

pub fn is_tracking_removal(&self) -> bool

Returns true if the storage tracks removal.

pub fn is_tracking_any(&self) -> bool

Returns true if the storage tracks insertion, modification, deletion or removal.

pub fn reserve(&mut self, additional: usize)

Reserves memory for at least additional components. Adding components can still allocate though.

pub fn clear(&mut self)

Deletes all components in this storage.

pub fn apply<R, F: FnOnce(&mut T, &T) -> R>(
    &mut self,
    a: EntityId,
    b: EntityId,
    f: F
) -> R

Applies the given function f to the entities a and b.
The two entities shouldn’t point to the same component.

Panics

• MissingComponent - if one of the entity doesn’t have any component in the storage.
• IdenticalIds - if the two entities point to the same component.

pub fn apply_mut<R, F: FnOnce(&mut T, &mut T) -> R>(
    &mut self,
    a: EntityId,
    b: EntityId,
    f: F
) -> R

Applies the given function f to the entities a and b.
The two entities shouldn’t point to the same component.

Panics

• MissingComponent - if one of the entity doesn’t have any component in the storage.
• IdenticalIds - if the two entities point to the same component.

pub fn drain(&mut self) -> SparseSetDrain<'_, T>

Creates a draining iterator that empties the storage and yields the removed items.

pub fn sort_unstable_by<F: FnMut(&T, &T) -> Ordering>(&mut self, compare: F)

Sorts the SparseSet with a comparator function, but may not preserve the order of equal elements.

pub fn sort_unstable(&mut self)

Sorts the SparseSet, but may not preserve the order of equal elements.

Trait Implementations

impl<T: 'static> AddComponent for ViewMut<'_, T>

type Component = T

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

Adds component to entity, multiple components can be added at the same time using a tuple.
This function does not check entity is alive. It’s possible to add components to removed entities.
Use Entities::add_component if you’re unsure.

impl<T: 'static> AddComponent for &mut ViewMut<'_, T>

type Component = T

fn add_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
)

Adds component to entity, multiple components can be added at the same time using a tuple.
This function does not check entity is alive. It’s possible to add components to removed entities.
Use Entities::add_component if you’re unsure.

impl<T: 'static> AddEntity for ViewMut<'_, T>

type Component = T

fn add_entity(&mut self, entity: EntityId, component: Self::Component)

Adds a new entity with component.

impl<T: 'static> AddEntity for &mut ViewMut<'_, T>

type Component = T

fn add_entity(&mut self, entity: EntityId, component: Self::Component)

Adds a new entity with component.

impl<'a, T> AsMut<SparseSet<T>> for ViewMut<'a, T>

fn as_mut(&mut self) -> &mut SparseSet<T>

Performs the conversion.

impl<'a, T> AsMut<ViewMut<'a, T>> for ViewMut<'a, T>

fn as_mut(&mut self) -> &mut Self

Performs the conversion.

impl<'a, T> AsRef<SparseSet<T>> for ViewMut<'a, T>

fn as_ref(&self) -> &SparseSet<T>

Performs the conversion.

impl<'a, T: 'static + Send + Sync> BorrowInfo for ViewMut<'a, T>

fn borrow_info(infos: &mut Vec<TypeInfo>)

This information is used during workload creation to determine which systems can run in parallel.

impl<T> BulkReserve for ViewMut<'_, T>

fn bulk_reserve(&mut self, new_entities: &[EntityId])

Reserves memory for all entities in new_entities.

impl<T> BulkReserve for &mut ViewMut<'_, T>

fn bulk_reserve(&mut self, new_entities: &[EntityId])

Reserves memory for all entities in new_entities.

impl<'a: 'b, 'b, T: 'static> Contains for &'b ViewMut<'a, T>

fn contains(&self, entity: EntityId) -> bool

Returns true if all storages contains entity.

impl<'a: 'b, 'b, T: 'static> Contains for &'b mut ViewMut<'a, T>

fn contains(&self, entity: EntityId) -> bool

Returns true if all storages contains entity.

impl<T: 'static> Delete for ViewMut<'_, T>

fn delete(&mut self, entity: EntityId) -> bool

Deletes the component(s) of an entity, they won’t be returned.
Returns true if all storages deleted a component.

impl<T: 'static> Delete for &mut ViewMut<'_, T>

fn delete(&mut self, entity: EntityId) -> bool

Deletes the component(s) of an entity, they won’t be returned.
Returns true if all storages deleted a component.

impl<T> Deref for ViewMut<'_, T>

type Target = SparseSet<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for ViewMut<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a: 'b, 'b, T: 'static> Get for &'b ViewMut<'a, T>

type Out = &'b T

type FastOut = &'b T

fn get(self, entity: EntityId) -> Result<Self::Out, MissingComponent>

Retrieve components of entity.

fn fast_get(self, entity: EntityId) -> Result<Self::FastOut, MissingComponent>

Retrieve components of entity without fine modification tracking.

impl<'a: 'b, 'b, T: 'static> Get for &'b mut ViewMut<'a, T>

type Out = Mut<'b, T>

type FastOut = &'b mut T

fn get(self, entity: EntityId) -> Result<Self::Out, MissingComponent>

Retrieve components of entity.

fn fast_get(self, entity: EntityId) -> Result<Self::FastOut, MissingComponent>

Retrieve components of entity without fine modification tracking.

impl<T: 'static + Send + Sync> IntoBorrow for ViewMut<'_, T>

type Borrow = ViewMutBorrower<T>

Helper type almost allowing GAT on stable.

impl<T> Not for &ViewMut<'_, T>

type Output = Not<Self>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T> Not for &mut ViewMut<'_, T>

type Output = Not<Self>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: 'static> Remove for ViewMut<'_, T>

type Out = Option<T>

Type of the removed component.

fn remove(&mut self, entity: EntityId) -> Self::Out

Removes component in entity, if the entity had a component, they will be returned.
Multiple components can be removed at the same time using a tuple.

impl<T: 'static> Remove for &mut ViewMut<'_, T>

type Out = Option<T>

Type of the removed component.

fn remove(&mut self, entity: EntityId) -> Self::Out

Removes component in entity, if the entity had a component, they will be returned.
Multiple components can be removed at the same time using a tuple.