Struct Modified

pub struct Modified<T> { /* private fields */ }

Query over modified component.

Should be used as either Modified<&T>, Modified<&mut T> or Modified<Alt<T>>.

This is tracking query that uses epoch lower bound to filter out entities with unmodified components.

Implementations

impl<T> Modified<T>

pub fn new(after_epoch: EpochId) -> Self

where T: Default,

Creates new Modified query. Uses provided after_epoch id to skip components that are last modified not after this epoch.

pub fn after_epoch(&self) -> EpochId

Epoch id threshold for this query.

Trait Implementations

impl<T> AsQuery for Modified<&T>

where T: 'static,

type Query = Modified<Read<T>>

Associated query type.

impl<T> AsQuery for Modified<&mut T>

where T: 'static,

type Query = Modified<Write<T>>

Associated query type.

impl<T> AsQuery for Modified<Alt<T>>

where T: 'static,

type Query = Modified<Alt<T>>

Associated query type.

impl<T> AsQuery for Modified<Cpy<T>>

where T: Copy + 'static,

type Query = Modified<Cpy<T>>

Associated query type.

impl<T> AsQuery for Modified<Option<&T>>

where T: 'static,

type Query = Modified<OptionQuery<Read<T>>>

Associated query type.

impl<T> AsQuery for Modified<Option<&mut T>>

where T: 'static,

type Query = Modified<OptionQuery<Write<T>>>

Associated query type.

impl<T> AsQuery for Modified<Option<Alt<T>>>

where T: 'static,

type Query = Modified<OptionQuery<Alt<T>>>

Associated query type.

impl<T> AsQuery for Modified<Option<Cpy<T>>>

where T: Copy + 'static,

type Query = Modified<OptionQuery<Cpy<T>>>

Associated query type.

impl<T> AsQuery for Modified<OptionQuery<Alt<T>>>

where T: 'static,

type Query = Modified<OptionQuery<Alt<T>>>

Associated query type.

impl<T> AsQuery for Modified<OptionQuery<Cpy<T>>>

where T: Copy + 'static,

type Query = Modified<OptionQuery<Cpy<T>>>

Associated query type.

impl<T> AsQuery for Modified<OptionQuery<Read<T>>>

where T: 'static,

type Query = Modified<OptionQuery<Read<T>>>

Associated query type.

impl<T> AsQuery for Modified<OptionQuery<Write<T>>>

where T: 'static,

type Query = Modified<OptionQuery<Write<T>>>

Associated query type.

impl<T> AsQuery for Modified<Read<T>>

where T: 'static,

type Query = Modified<Read<T>>

Associated query type.

impl<T> AsQuery for Modified<With<T>>

where T: 'static,

type Query = Modified<With<T>>

Associated query type.

impl<T> AsQuery for Modified<Write<T>>

where T: 'static,

type Query = Modified<Write<T>>

Associated query type.

impl<T: Clone> Clone for Modified<T>

fn clone(&self) -> Modified<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Modified<T>

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

Formats the value using the given formatter.

impl<T> ImmutableQuery for Modified<Cpy<T>>

where T: Copy + 'static,

const CHECK_VALID: () = _

Checks that query is valid in compile time.

impl<T> ImmutableQuery for Modified<OptionQuery<Cpy<T>>>

where T: Copy + 'static,

const CHECK_VALID: () = _

Checks that query is valid in compile time.

impl<T> ImmutableQuery for Modified<OptionQuery<Read<T>>>

where T: 'static,

const CHECK_VALID: () = _

Checks that query is valid in compile time.

impl<T> ImmutableQuery for Modified<Read<T>>

where T: 'static,

const CHECK_VALID: () = _

Checks that query is valid in compile time.

impl<T> ImmutableQuery for Modified<With<T>>

where T: 'static,

const CHECK_VALID: () = _

Checks that query is valid in compile time.

impl<T> IntoQuery for Modified<Alt<T>>

where T: 'static,

fn into_query(self) -> Self::Query

Converts into query.

impl<T> IntoQuery for Modified<Cpy<T>>

where T: Copy + 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for Modified<OptionQuery<Alt<T>>>

where T: 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for Modified<OptionQuery<Cpy<T>>>

where T: Copy + 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for Modified<OptionQuery<Read<T>>>

where T: 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for Modified<OptionQuery<Write<T>>>

where T: 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for Modified<Read<T>>

where T: 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for Modified<With<T>>

where T: 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for Modified<Write<T>>

where T: 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> Query for Modified<Alt<T>>

where T: 'static,

const MUTABLE: bool = true

Set to true if query fetches at least one mutable component.

type Item<'a> = RefMut<'a, T>

Item type this query type yields.

type Fetch<'a> = ModifiedFetchAlt<'a, T>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, _archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, epoch: EpochId, ) -> ModifiedFetchAlt<'a, T>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<Cpy<T>>

where T: Copy + 'static,

const MUTABLE: bool = false

Set to true if query fetches at least one mutable component.

type Item<'a> = T

Item type this query type yields.

type Fetch<'a> = ModifiedFetchCopied<'a, T>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, _archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, _epoch: EpochId, ) -> ModifiedFetchCopied<'a, T>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<OptionQuery<Alt<T>>>

where T: 'static,

const MUTABLE: bool = true

Set to true if query fetches at least one mutable component.

type Item<'a> = Option<RefMut<'a, T>>

Item type this query type yields.

type Fetch<'a> = Option<ModifiedFetchAlt<'a, T>>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, epoch: EpochId, ) -> Option<ModifiedFetchAlt<'a, T>>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<OptionQuery<Cpy<T>>>

where T: Copy + 'static,

const MUTABLE: bool = false

Set to true if query fetches at least one mutable component.

type Item<'a> = Option<T>

Item type this query type yields.

type Fetch<'a> = Option<ModifiedFetchCopied<'a, T>>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, _epoch: EpochId, ) -> Option<ModifiedFetchCopied<'a, T>>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<OptionQuery<Read<T>>>

where T: 'static,

const MUTABLE: bool = false

Set to true if query fetches at least one mutable component.

type Item<'a> = Option<&'a T>

Item type this query type yields.

type Fetch<'a> = Option<ModifiedFetchRead<'a, T>>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, _epoch: EpochId, ) -> Option<ModifiedFetchRead<'a, T>>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<OptionQuery<Write<T>>>

where T: 'static,

const MUTABLE: bool = true

Set to true if query fetches at least one mutable component.

type Item<'a> = Option<&'a mut T>

Item type this query type yields.

type Fetch<'a> = Option<ModifiedFetchWrite<'a, T>>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, epoch: EpochId, ) -> Option<ModifiedFetchWrite<'a, T>>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<Read<T>>

where T: 'static,

const MUTABLE: bool = false

Set to true if query fetches at least one mutable component.

type Item<'a> = &'a T

Item type this query type yields.

type Fetch<'a> = ModifiedFetchRead<'a, T>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, _archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, _epoch: EpochId, ) -> ModifiedFetchRead<'a, T>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<With<T>>

where T: 'static,

const MUTABLE: bool = false

Set to true if query fetches at least one mutable component.

type Item<'a> = ()

Item type this query type yields.

type Fetch<'a> = ModifiedFetchWith<'a, T>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, _archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, _epoch: EpochId, ) -> ModifiedFetchWith<'a, T>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> Query for Modified<Write<T>>

where T: 'static,

const MUTABLE: bool = true

Set to true if query fetches at least one mutable component.

type Item<'a> = &'a mut T

Item type this query type yields.

type Fetch<'a> = ModifiedFetchWrite<'a, T>

Fetch value type for this query type. Contains data from one archetype.

fn component_access( &self, comp: &ComponentInfo, ) -> Result<Option<Access>, WriteAlias>

Returns what kind of access the query performs on the component type. This method may return stronger access type if it is impossible to know exact access with only type-id.

fn visit_archetype(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped. If returns false, access_archetype and fetch must not be called, meaning that complex query should either skip archetype entirely or for this query specifically.

unsafe fn access_archetype( &self, _archetype: &Archetype, f: impl FnMut(TypeId, Access), )

Asks query to provide types and access for the specific archetype. Must call provided closure with type id and access pairs. Only types from archetype must be used to call closure.

unsafe fn fetch<'a>( &self, _arch_idx: u32, archetype: &'a Archetype, epoch: EpochId, ) -> ModifiedFetchWrite<'a, T>

Fetches data from one archetype.

const FILTERS_ENTITIES: bool = false

Set to true if query filters individual entities.

fn visit_archetype_late(&self, archetype: &Archetype) -> bool

Checks if archetype must be visited or skipped a second time after required access was granted.

fn reserved_entity_item<'a>( &self, id: EntityId, idx: u32, ) -> Option<Self::Item<'a>>

Returns item for reserved entity if reserved entity (no components) satisfies the query. Otherwise returns None.

impl<T> QueryArg for Modified<Alt<T>>

where T: Send + 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T> QueryArg for Modified<Cpy<T>>

where T: Copy + Sync + 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T> QueryArg for Modified<OptionQuery<Alt<T>>>

where T: Send + 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T> QueryArg for Modified<OptionQuery<Cpy<T>>>

where T: Copy + Sync + 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T> QueryArg for Modified<OptionQuery<Read<T>>>

where T: Sync + 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T> QueryArg for Modified<Read<T>>

where T: Sync + 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T> QueryArg for Modified<With<T>>

where T: 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T> QueryArg for Modified<Write<T>>

where T: Send + 'static,

fn new() -> Self

Creates new query state.

fn after(&mut self, world: &World)

Hook called after function-system runs to update the state.

fn before(&mut self, world: &World)

Hook called before function-system runs to update the state.

impl<T: Copy> Copy for Modified<T>

impl<T> SendQuery for Modified<Alt<T>>

where T: Send + 'static,

impl<T> SendQuery for Modified<Cpy<T>>

where T: Sync + Copy + 'static,

impl<T> SendQuery for Modified<OptionQuery<Alt<T>>>

where T: Send + 'static,

impl<T> SendQuery for Modified<OptionQuery<Cpy<T>>>

where T: Sync + Copy + 'static,

impl<T> SendQuery for Modified<OptionQuery<Read<T>>>

where T: Sync + 'static,

impl<T> SendQuery for Modified<OptionQuery<Write<T>>>

where T: Send + 'static,

impl<T> SendQuery for Modified<Read<T>>

where T: Sync + 'static,

impl<T> SendQuery for Modified<With<T>>

where T: 'static,

impl<T> SendQuery for Modified<Write<T>>

where T: Send + 'static,