Struct shipyard::Window

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

Shared slice of a storage.

Implementations

impl<'w, T> Window<'w, T>

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_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_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 modified section of an update packed window.
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_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 window.

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

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

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.

Trait Implementations

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

fn as_ref(&self) -> &Window<'a, T>

Performs the conversion.

impl<T> Clone for Window<'_, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a: 'b, 'b, T: 'static> Get for &'b Window<'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<T> Index<EntityId> for Window<'_, T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.