Struct shipyard::View

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

Shared view over a component storage.

Implementations

impl<T> View<'_, 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.

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

Trait Implementations

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

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

Performs the conversion.

impl<'a, T: 'static + Send + Sync> BorrowInfo for View<'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<'a, T> Clone for View<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Returns true if all storages contains entity.

impl<'a, T> Deref for View<'a, T>

type Target = SparseSet<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a: 'b, 'b, T: 'static> Get for &'b View<'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<T: 'static + Send + Sync> IntoBorrow for View<'_, T>

type Borrow = ViewBorrower<T>

Helper type almost allowing GAT on stable.

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

type Output = Not<Self>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.