Struct shipyard::ViewMut

pub struct ViewMut<'a, T: Component, Tracking: Tracking = <T as Component>::Tracking> { /* private fields */ }

Exclusive view over a component storage.

Implementations

impl<'a, T: Component<Tracking = Untracked>> ViewMut<'a, T, Untracked>

pub fn new_for_custom_storage(
    storage_id: StorageId,
    all_storages: Ref<'a, &'a AllStorages>
) -> Result<Self, CustomStorageView>

Creates a new ViewMut for custom SparseSet storage.

use shipyard::{track, Component, SparseSet, StorageId, ViewMut, World};

struct ScriptingComponent(Vec<u8>);
impl Component for ScriptingComponent {
    type Tracking = track::Untracked;
}

let world = World::new();

world.add_custom_storage(
    StorageId::Custom(0),
    SparseSet::<ScriptingComponent>::new_custom_storage(),
).unwrap();

let all_storages = world.all_storages().unwrap();
let scripting_storage =
    ViewMut::<ScriptingComponent>::new_for_custom_storage(StorageId::Custom(0), all_storages)
        .unwrap();

impl<'a, T: Component> ViewMut<'a, T>

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 is_inserted(&self, entity: EntityId) -> bool

Inside a workload returns true if entity’s component was inserted since the last run of this system.
Outside workloads returns true if entity’s component was inserted since the last call to clear_all_inserted.
Returns false if entity does not have a component in this storage.

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

Inside a workload returns true if entity’s component was modified since the last run of this system.
Outside workloads returns true if entity’s component was modified since the last call to clear_all_modified.
Returns false if entity does not have a component in this storage.

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

Inside a workload returns true if entity’s component was inserted or modified since the last run of this system.
Outside workloads 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 is_deleted(&self, entity: EntityId) -> bool

Inside a workload returns true if entity’s component was deleted since the last run of this system.
Outside workloads returns true if entity’s component was deleted since the last call to clear_all_deleted.
Returns false if entity does not have a component in this storage.

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

Inside a workload returns true if entity’s component was removed since the last run of this system.
Outside workloads returns true if entity’s component was removed since the last call to clear_all_removed.
Returns false if entity does not have a component in this storage.

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

Inside a workload returns true if entity’s component was deleted or removed since the last run of this system.
Outside workloads returns true if entity’s component was deleted or removed since the last clear call.
Returns false if entity does not have a component in this storage.

pub fn clear(&mut self)

Deletes all components in this storage.

impl<T: Component<Tracking = Insertion>> ViewMut<'_, T, Insertion>

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

Wraps this view to be able to iterate inserted 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 inserted_or_modified_mut(&mut self) -> InsertedOrModified<&mut Self>

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

pub fn clear_all_inserted(self)

Removes the inserted flag on all components of this storage.

impl<T: Component<Tracking = Modification>> ViewMut<'_, T, Modification>

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 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.

pub fn clear_all_modified(self)

Removes the modified flag on all components of this storage.

impl<T: Component<Tracking = Deletion>> ViewMut<'_, T, Deletion>

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

Returns the deleted components of a storage tracking deletion.

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.

impl<T: Component<Tracking = Removal>> ViewMut<'_, T, Removal>

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

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

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.

impl<T: Component<Tracking = All>> ViewMut<'_, T, All>

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.

pub fn clear_all_inserted(self)

Removes the inserted flag on all components of this storage.

pub fn clear_all_modified(self)

Removes the modified flag on all components of this storage.

pub fn clear_all_inserted_and_modified(self)

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

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

Returns the deleted components of a storage tracking deletion.

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

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

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.

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 clear_all_deleted(&mut self)

Clear all deletion tracking data.

pub fn clear_all_deleted_older_than_timestamp(
    &mut self,
    timestamp: TrackingTimestamp
)

Clear all deletion tracking data older than some timestamp.

pub fn clear_all_removed_or_deleted(&mut self)

Clear all deletion and removal tracking data.

pub fn clear_all_removed_or_deleted_older_than_timestamp(
    &mut self,
    timestamp: TrackingTimestamp
)

Clear all deletion and removal tracking data older than some timestamp.

pub fn clear_all_removed(&mut self)

Clear all removal tracking data.

pub fn clear_all_removed_older_than_timestamp(
    &mut self,
    timestamp: TrackingTimestamp
)

Clear all removal tracking data older than some timestamp.

pub fn clear_all_removed_and_deleted(&mut self)

Clear all deletion and removal tracking data.

pub fn clear_all_removed_or_deleted_older_than_timestamp(
    &mut self,
    timestamp: TrackingTimestamp
)

Clear all deletion and removal tracking data older than some timestamp.

pub fn clear_all_deleted(&mut self)

Clear all deletion tracking data.

pub fn clear_all_deleted_older_than_timestamp(
    &mut self,
    timestamp: TrackingTimestamp
)

Clear all deletion tracking data older than some timestamp.

pub fn clear_all_removed(&mut self)

Clear all removal tracking data.

pub fn clear_all_removed_older_than_timestamp(
    &mut self,
    timestamp: TrackingTimestamp
)

Clear all removal tracking data older than some timestamp.

pub fn clear_all_removed_and_deleted(&mut self)

Clear all deletion and removal tracking data.

pub fn clear_all_removed_or_deleted_older_than_timestamp(
    &mut self,
    timestamp: TrackingTimestamp
)

Clear all deletion and removal tracking data older than some timestamp.

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 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: Component> 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: Component> 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: Component + PartialEq> AddDistinctComponent for &mut ViewMut<'_, T>

type Component = T

fn add_distinct_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
) -> bool

Adds component to entity, multiple components can be added at the same time using a tuple.
If the entity already has this component, it won’t be replaced. Very useful if you want accurate modification tracking.
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: Component + PartialEq> AddDistinctComponent for ViewMut<'_, T>

type Component = T

fn add_distinct_component_unchecked(
    &mut self,
    entity: EntityId,
    component: Self::Component
) -> bool

Adds component to entity, multiple components can be added at the same time using a tuple.
If the entity already has this component, it won’t be replaced. Very useful if you want accurate modification tracking.
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: Component> AddEntity for &mut ViewMut<'_, T>

type Component = T

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

Adds a new entity with component.

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

type Component = T

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

Adds a new entity with component.

impl<'a, T: Component> AsMut<SparseSet<T, <T as Component>::Tracking>> for ViewMut<'a, T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a, T: Component> AsMut<ViewMut<'a, T, <T as Component>::Tracking>> for ViewMut<'a, T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a, T: Component> AsRef<SparseSet<T, <T as Component>::Tracking>> for ViewMut<'a, T>

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, T: Component, U: IntoAbstract> BitOr<U> for &'a ViewMut<'a, T>

type Output = Or<(&'a ViewMut<'a, T, <T as Component>::Tracking>, U)>

The resulting type after applying the | operator.

fn bitor(self, rhs: U) -> Self::Output

Performs the | operation.

impl<'a, T: Component, U: IntoAbstract> BitOr<U> for &'a mut ViewMut<'a, T>

type Output = Or<(&'a mut ViewMut<'a, T, <T as Component>::Tracking>, U)>

The resulting type after applying the | operator.

fn bitor(self, rhs: U) -> Self::Output

Performs the | operation.

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

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

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

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

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

Reserves memory for all entities in new_entities.

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

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

Reserves memory for all entities in new_entities.

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

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

Returns true if all storages contains entity.

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

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

Returns true if all storages contains entity.

impl<T: Debug + Component> Debug for ViewMut<'_, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

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

Deletes component in entity, return true if the entity had this component.
Multiple components can be deleted at the same time using a tuple.

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

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

Deletes component in entity, return true if the entity had this component.
Multiple components can be deleted at the same time using a tuple.

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

type Target = SparseSet<T, <T as Component>::Tracking>

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

type Out = &'b T

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

Retrieve components of entity.

impl<'a, 'b, T: Component<Tracking = All>> Get for &'b mut ViewMut<'a, T, All>

type Out = Mut<'b, T>

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

Retrieve components of entity.

impl<'a, 'b, T: Component<Tracking = Deletion>> Get for &'b mut ViewMut<'a, T, Deletion>

type Out = &'b mut T

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

Retrieve components of entity.

impl<'a, 'b, T: Component<Tracking = Insertion>> Get for &'b mut ViewMut<'a, T, Insertion>

type Out = &'b mut T

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

Retrieve components of entity.

impl<'a, 'b, T: Component<Tracking = Modification>> Get for &'b mut ViewMut<'a, T, Modification>

type Out = Mut<'b, T>

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

Retrieve components of entity.

impl<'a, 'b, T: Component<Tracking = Removal>> Get for &'b mut ViewMut<'a, T, Removal>

type Out = &'b mut T

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

Retrieve components of entity.

impl<'a, 'b, T: Component<Tracking = Untracked>> Get for &'b mut ViewMut<'a, T, Untracked>

type Out = &'b mut T

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

Retrieve components of entity.

impl<'a, T: Component> Index<EntityId> for ViewMut<'a, T>

type Output = T

The returned type after indexing.

fn index(&self, entity: EntityId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: Component<Tracking = All>> IndexMut<EntityId> for ViewMut<'a, T, All>

fn index_mut(&mut self, entity: EntityId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T: Component<Tracking = Deletion>> IndexMut<EntityId> for ViewMut<'a, T, Deletion>

fn index_mut(&mut self, entity: EntityId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T: Component<Tracking = Insertion>> IndexMut<EntityId> for ViewMut<'a, T, Insertion>

fn index_mut(&mut self, entity: EntityId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T: Component<Tracking = Modification>> IndexMut<EntityId> for ViewMut<'a, T, Modification>

fn index_mut(&mut self, entity: EntityId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T: Component<Tracking = Removal>> IndexMut<EntityId> for ViewMut<'a, T, Removal>

fn index_mut(&mut self, entity: EntityId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T: Component<Tracking = Untracked>> IndexMut<EntityId> for ViewMut<'a, T, Untracked>

fn index_mut(&mut self, entity: EntityId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a: 'b, 'b, T: Component> IntoAbstract for &'b ViewMut<'a, T>

type AbsView = FullRawWindow<'b, T, <T as Component>::Tracking>

impl<'a: 'b, 'b, T: Component<Tracking = All>> IntoAbstract for &'b mut ViewMut<'a, T, All>

type AbsView = FullRawWindowMut<'b, T, All>

impl<'a: 'b, 'b, T: Component<Tracking = Insertion>> IntoAbstract for &'b mut ViewMut<'a, T, Insertion>

type AbsView = FullRawWindowMut<'b, T, Insertion>

impl<'a: 'b, 'b, T: Component<Tracking = Modification>> IntoAbstract for &'b mut ViewMut<'a, T, Modification>

type AbsView = FullRawWindowMut<'b, T, Modification>

impl<'a: 'b, 'b, T: Component<Tracking = Removal>> IntoAbstract for &'b mut ViewMut<'a, T, Removal>

type AbsView = FullRawWindowMut<'b, T, Removal>

impl<'a: 'b, 'b, T: Component<Tracking = Untracked>> IntoAbstract for &'b mut ViewMut<'a, T, Untracked>

type AbsView = FullRawWindowMut<'b, T, Untracked>

impl<T: Send + Sync + Component> IntoBorrow for ViewMut<'_, T> where
    T::Tracking: Send + Sync, 

type Borrow = ViewMutBorrower<T>

Helper type almost allowing GAT on stable.

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

type Output = Not<&ViewMut<'_, T, <T as Component>::Tracking>>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

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

type Output = Not<&mut ViewMut<'_, T, <T as Component>::Tracking>>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: Component> 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.

impl<T: Component> 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.