Struct QueryBorrowAny

pub struct QueryBorrowAny<T>(pub T);

Query that borrows from components.

Tuple Fields

0: T

Trait Implementations

impl<T> AsQuery for QueryBorrowAny<&T>

where T: ?Sized + 'static,

type Query = QueryBorrowAny<Read<T>>

Associated query type.

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

where T: ?Sized + 'static,

type Query = QueryBorrowAny<Write<T>>

Associated query type.

impl<T> AsQuery for QueryBorrowAny<Read<T>>

where T: ?Sized + 'static,

type Query = QueryBorrowAny<Read<T>>

Associated query type.

impl<T> AsQuery for QueryBorrowAny<Write<T>>

where T: ?Sized + 'static,

type Query = QueryBorrowAny<Write<T>>

Associated query type.

impl<T: Clone> Clone for QueryBorrowAny<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for QueryBorrowAny<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for QueryBorrowAny<T>

fn default() -> QueryBorrowAny<T>

Returns the “default value” for a type.

impl<T> DefaultQuery for QueryBorrowAny<&T>

where T: ?Sized + 'static,

fn default_query() -> QueryBorrowAny<Read<T>>

Returns default query instance.

impl<T> DefaultQuery for QueryBorrowAny<&mut T>

where T: ?Sized + 'static,

fn default_query() -> QueryBorrowAny<Write<T>>

Returns default query instance.

impl<T> DefaultQuery for QueryBorrowAny<Read<T>>

where T: ?Sized + 'static,

fn default_query() -> Self

Returns default query instance.

impl<T> DefaultQuery for QueryBorrowAny<Write<T>>

where T: ?Sized + 'static,

fn default_query() -> Self

Returns default query instance.

impl<T> ImmutableQuery for QueryBorrowAny<Read<T>>

where T: ?Sized + 'static,

const CHECK_VALID: () = _

Checks that query is valid in compile time.

impl<T> IntoQuery for QueryBorrowAny<Read<T>>

where T: ?Sized + 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> IntoQuery for QueryBorrowAny<Write<T>>

where T: ?Sized + 'static,

fn into_query(self) -> Self

Converts into query.

impl<T> Query for QueryBorrowAny<Read<T>>

where T: ?Sized + '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> = FetchBorrowAnyRead<'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, ) -> FetchBorrowAnyRead<'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 QueryBorrowAny<Write<T>>

where T: ?Sized + '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> = FetchBorrowAnyWrite<'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, ) -> FetchBorrowAnyWrite<'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 QueryBorrowAny<Read<T>>

where T: Sync + ?Sized + 'static,

fn new() -> Self

Creates new query state.

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

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

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

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

impl<T> QueryArg for QueryBorrowAny<Write<T>>

where T: Send + ?Sized + 'static,

fn new() -> Self

Creates new query state.

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

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

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

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

impl<T: Copy> Copy for QueryBorrowAny<T>

impl<T> SendQuery for QueryBorrowAny<Read<T>>

where T: Sync + ?Sized + 'static,

impl<T> SendQuery for QueryBorrowAny<Write<T>>

where T: Send + ?Sized + 'static,