Struct shipyard::ViewMut

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

Exclusive view over a component storage.

Methods from Deref<Target = SparseSet<T>>

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

Removes entity’s component from this storage.

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

Removes entity’s component from this storage.
Unwraps errors.

pub fn try_delete(&mut self, entity: EntityId) -> Result<(), Remove> where
    T: 'static, 

Deletes entity’s component from this storage.

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

Deletes entity’s component from this storage.
Unwraps errors.

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

Returns true if the window contains entity.

pub fn len(&self) -> usize

Returns the length of the window.

pub fn is_empty(&self) -> bool

Returns true if the window’s length is 0.

pub fn try_inserted(&self) -> Result<Window<'_, T>, Inserted>

Returns the inserted section of an update packed window.

pub fn inserted(&self) -> Window<'_, T>

Returns the inserted section of an update packed window.
Unwraps errors.

pub fn try_inserted_mut(&mut self) -> Result<WindowMut<'_, T>, Inserted>

Returns the inserted section of an update packed window mutably.

pub fn inserted_mut(&mut self) -> WindowMut<'_, T>

Returns the inserted section of an update packed window mutably.
Unwraps errors.

pub fn try_modified(&self) -> Result<Window<'_, T>, Modified>

Returns the modified section of an update packed window.

pub fn modified(&self) -> Window<'_, T>

Returns the modified section of an update packed window.
Unwraps errors.

pub fn try_modified_mut(&mut self) -> Result<WindowMut<'_, T>, Modified>

Returns the modified section of an update packed window mutably.

pub fn modified_mut(&mut self) -> WindowMut<'_, T>

Returns the modified section of an update packed window mutably.
Unwraps errors.

pub fn try_inserted_or_modified(
    &self
) -> Result<Window<'_, T>, InsertedOrModified>

Returns the inserted and modified section of an update packed window.

pub fn inserted_or_modified(&self) -> Window<'_, T>

Returns the inserted and modified section of an update packed window.
Unwraps errors.

pub fn try_inserted_or_modified_mut(
    &mut self
) -> Result<WindowMut<'_, T>, InsertedOrModified>

Returns the inserted and modified section of an update packed window mutably.

pub fn inserted_or_modified_mut(&mut self) -> WindowMut<'_, T>

Returns the inserted and modified section of an update packed window mutably.
Unwraps errors.

pub fn try_deleted(&self) -> Result<&[(EntityId, T)], NotUpdatePack>

Returns the deleted components of an update packed window.

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

Returns the deleted components of an update packed window.
Unwraps errors.

pub fn try_take_deleted(&mut self) -> Result<Vec<(EntityId, T)>, NotUpdatePack>

Takes ownership of the deleted components of an update packed window.

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

Takes ownership of the deleted components of an update packed window.
Unwraps errors.

pub fn try_clear_inserted(&mut self) -> Result<(), NotUpdatePack>

Moves all component in the inserted section of an update packed window to the neutral section.

pub fn clear_inserted(&mut self)

Moves all component in the inserted section of an update packed window to the neutral section.
Unwraps errors.

pub fn try_clear_modified(&mut self) -> Result<(), NotUpdatePack>

Moves all component in the modified section of an update packed window to the neutral section.

pub fn clear_modified(&mut self)

Moves all component in the modified section of an update packed window to the neutral section.
Unwraps errors.

pub fn try_clear_inserted_and_modified(&mut self) -> Result<(), NotUpdatePack>

Moves all component in the inserted and modified section of an update packed window to the neutral section.

pub fn clear_inserted_and_modified(&mut self)

Moves all component in the inserted and modified section of an update packed window to the neutral section.
Unwraps errors.

pub fn try_update_pack(&mut self) -> Result<(), Pack> where
    T: 'static, 

Update packs this storage making it track inserted, modified and deleted components.

pub fn update_pack(&mut self) where
    T: 'static, 

Update packs this storage making it track inserted, modified and deleted components.
Unwraps errors.

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 try_id_at(&self, index: usize) -> Option<EntityId>

Returns the EntityId at a given index.

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

Returns the EntityId at a given index.
Unwraps errors.

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 in this storage.
In case it used to but no longer does, the result will be wrong but won’t trigger any UB.

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

Returns a slice of all the components in this storage.

pub fn try_as_window<R: RangeBounds<usize>>(
    &self,
    range: R
) -> Result<Window<'_, T>, NotInbound>

Returns a window over range.

pub fn as_window<R: RangeBounds<usize>>(&self, range: R) -> Window<'_, T>

Returns a window over range.
Unwraps errors.

pub fn try_as_window_mut<R: RangeBounds<usize>>(
    &mut self,
    range: R
) -> Result<WindowMut<'_, T>, NotInbound>

Returns a mutable window over range.

pub fn as_window_mut<R: RangeBounds<usize>>(
    &mut self,
    range: R
) -> WindowMut<'_, T>

Returns a mutable window over range.
Unwraps errors.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Retrieve components of entity.

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

Retrieve components of entity.
Unwraps errors.

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

type Out = &'b mut T

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

Retrieve components of entity.

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

Retrieve components of entity.
Unwraps errors.

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<'a, T: 'static + Send + Sync> TryFrom<&'a AllStorages> for ViewMut<'a, T>

type Error = GetStorage

The type returned in the event of a conversion error.

fn try_from(all_storages: &'a AllStorages) -> Result<Self, Self::Error>

Performs the conversion.