Struct UniqueView

pub struct UniqueView<'a, T: Unique> { /* private fields */ }

Shared view over a unique component storage.

Implementations

impl<T: Unique> UniqueView<'_, T>

pub fn clone(unique: &Self) -> Self

Duplicates the UniqueView.

Clone is not implemented to not conflict with T::clone.

pub fn override_last_insertion( &mut self, new_timestamp: TrackingTimestamp, ) -> TrackingTimestamp

Replaces the timestamp starting the tracking time window for insertions.

Tracking works based on a time window. From the last time the system ran (in workloads) or since the last clear.

Sometimes this automatic time window isn’t what you need. This can happen when you want to keep the same tracking information for multiple runs of the same system.

For example if you interpolate movement between frames, you might run an interpolation workload multiple times but not change the World during its execution.
In this case you want the same tracking information for all runs of this workload which would have disappeared using the automatic window.

pub fn override_last_modification( &mut self, new_timestamp: TrackingTimestamp, ) -> TrackingTimestamp

Replaces the timestamp starting the tracking time window for modifications.

Tracking works based on a time window. From the last time the system ran (in workloads) or since the last clear.

Sometimes this automatic time window isn’t what you need. This can happen when you want to keep the same tracking information for multiple runs of the same system.

For example if you interpolate movement between frames, you might run an interpolation workload multiple times but not change the World during its execution.
In this case you want the same tracking information for all runs of this workload which would have disappeared using the automatic window.

impl<T: Unique> UniqueView<'_, T>

pub fn is_inserted(&self) -> bool

Returns true if the component was inserted before the last clear_inserted call.

pub fn is_modified(&self) -> bool

Returns true is the component was modified since the last clear_modified call.

pub fn is_inserted_or_modified(&self) -> bool

Returns true if the component was inserted or modified since the last clear_inserted or clear_modified call.

Trait Implementations

impl<T: Unique> AsRef<T> for UniqueView<'_, T>

fn as_ref(&self) -> &T

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

impl<T: Send + Sync + Unique> Borrow for UniqueView<'_, T>

type View<'a> = UniqueView<'a, T>

fn borrow<'a>( all_storages: &'a AllStorages, all_borrow: Option<SharedBorrow<'a>>, last_run: Option<TrackingTimestamp>, current: TrackingTimestamp, ) -> Result<Self::View<'a>, GetStorage>

This function is where the actual borrowing happens.

impl<'a, T: Send + Sync + Unique> BorrowInfo for UniqueView<'a, T>

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

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

fn enable_tracking(_: &mut Vec<fn(&AllStorages) -> Result<(), GetStorage>>)

Enable tracking on the World where this storage is borrowed.

impl<T: Debug + Unique> Debug for UniqueView<'_, T>

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

Formats the value using the given formatter.

impl<T: Unique> Deref for UniqueView<'_, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.