Struct TurnState 

pub struct TurnState {
    pub run_of: &'static ChildOf,
    pub materialised: Has<Materialised>,
    pub batched: Has<Batch>,
}

What the cancel observer reads of a turn: its run, whether it was read, whether its batch is out.

Fields

run_of: &'static ChildOf

The run the turn is ChildOf.

materialised: Has<Materialised>

Whether Materialise read the turn.

batched: Has<Batch>

Whether the turn’s batch is out.

Trait Implementations

impl ArchetypeQueryData for TurnState

where for<'__a> &'static ChildOf: ArchetypeQueryData, for<'__a> Has<Materialised>: ArchetypeQueryData, for<'__a> Has<Batch>: ArchetypeQueryData,

impl IterQueryData for TurnState

where for<'__a> &'static ChildOf: IterQueryData, for<'__a> Has<Materialised>: IterQueryData, for<'__a> Has<Batch>: IterQueryData,

impl QueryData for TurnState

unsafe fn fetch<'__w, '__s>( _state: &'__s Self::State, _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow, ) -> Option<Self::Item<'__w, '__s>>

SAFETY: we call fetch for each member that implements Fetch.

const IS_READ_ONLY: bool = true

True if this query is read-only and may not perform mutable access.

const IS_ARCHETYPAL: bool

Returns true if (and only if) this query data relies strictly on archetypes to limit which entities are accessed by the Query.

type ReadOnly = TurnState

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.

type Item<'__w, '__s> = TurnStateItem<'__w, '__s>

The item returned by this WorldQuery This will be the data retrieved by the query, and is visible to the end user when calling e.g. Query<Self>::get.

fn shrink<'__wlong: '__wshort, '__wshort, '__s>( item: Self::Item<'__wlong, '__s>, ) -> Self::Item<'__wshort, '__s>

This function manually implements subtyping for the query items.

fn provide_extra_access( state: &mut Self::State, access: &mut Access, available_access: &Access, )

Offers additional access above what we requested in update_component_access. Implementations may add additional access that is a subset of available_access and does not conflict with anything in access, and must update access to include that access.

fn iter_access(_state: &Self::State) -> impl Iterator<Item = EcsAccessType<'_>>

Returns an iterator over the access needed by QueryData::fetch. Access conflicts are usually checked in WorldQuery::update_component_access, but in certain cases this method can be useful to implement a way of checking for access conflicts in a non-allocating way.

impl ReadOnlyQueryData for TurnState

impl ReleaseStateQueryData for TurnState

where for<'__a> &'static ChildOf: ReleaseStateQueryData, for<'__a> Has<Materialised>: ReleaseStateQueryData, for<'__a> Has<Batch>: ReleaseStateQueryData,

fn release_state<'__w>(_item: Self::Item<'__w, '_>) -> Self::Item<'__w, 'static>

Releases the borrow from the query state by converting an item to have a 'static state lifetime.

impl SingleEntityQueryData for TurnState

where for<'__a> &'static ChildOf: SingleEntityQueryData, for<'__a> Has<Materialised>: SingleEntityQueryData, for<'__a> Has<Batch>: SingleEntityQueryData,

impl WorldQuery for TurnState

unsafe fn set_archetype<'__w, '__s>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &'__s Self::State, _archetype: &'__w Archetype, _table: &'__w Table, )

SAFETY: we call set_archetype for each member that implements Fetch

unsafe fn set_table<'__w, '__s>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &'__s Self::State, _table: &'__w Table, )

SAFETY: we call set_table for each member that implements Fetch

const IS_DENSE: bool

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components.

type Fetch<'__w> = TurnStateFetch<'__w>

Per archetype/table state retrieved by this WorldQuery to compute Self::Item for each entity.

type State = TurnStateState

State used to construct a Self::Fetch. This will be cached inside QueryState, so it is best to move as much data / computation here as possible to reduce the cost of constructing Self::Fetch.

fn shrink_fetch<'__wlong: '__wshort, '__wshort>( fetch: <TurnState as WorldQuery>::Fetch<'__wlong>, ) -> <TurnState as WorldQuery>::Fetch<'__wshort>

This function manually implements subtyping for the query fetches.

unsafe fn init_fetch<'__w, '__s>( _world: UnsafeWorldCell<'__w>, state: &'__s Self::State, _last_run: Tick, _this_run: Tick, ) -> <Self as WorldQuery>::Fetch<'__w>

Creates a new instance of Self::Fetch, by combining data from the World with the cached Self::State. Readonly accesses resources registered in WorldQuery::update_component_access.

fn update_component_access(state: &Self::State, _access: &mut FilteredAccess)

Adds any component accesses to the current entity used by this WorldQuery to access.

fn init_nested_access( state: &Self::State, _system_name: Option<&str>, _component_access_set: &mut FilteredAccessSet, _world: UnsafeWorldCell<'_>, )

Adds any component accesses to other entities used by this WorldQuery.

fn init_state(world: &mut World) -> TurnStateState

Creates and initializes a State for this WorldQuery type.

fn get_state(components: &Components) -> Option<TurnStateState>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.

fn matches_component_set( state: &Self::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.

fn update_archetypes(_state: &mut Self::State, _world: UnsafeWorldCell<'_>)

Called when the query state is updating its archetype cache. This can be used by nested queries to update their internal archetype caches.