Struct RelatesTo

pub struct RelatesTo<R> { /* private fields */ }

Query for origins of relation with specified target.

Yields relation instance.

Implementations

impl<R> RelatesTo<R>

pub fn new(target: EntityId) -> Self

Returns relation query bound to one specific target entity.

Trait Implementations

impl<R> AsQuery for RelatesTo<&R>

where R: Relation + 'static,

type Query = RelatesTo<Read<R>>

Associated query type.

impl<R> AsQuery for RelatesTo<&mut R>

where R: Relation,

type Query = RelatesTo<Write<R>>

Associated query type.

impl<R> AsQuery for RelatesTo<Read<R>>

where R: Relation + 'static,

type Query = RelatesTo<Read<R>>

Associated query type.

impl<R> AsQuery for RelatesTo<Write<R>>

where R: Relation,

type Query = RelatesTo<Write<R>>

Associated query type.

impl<R> Clone for RelatesTo<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R> Debug for RelatesTo<R>

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

Formats the value using the given formatter.

impl<R> ImmutableQuery for RelatesTo<Read<R>>

where R: Relation,

const CHECK_VALID: () = _

Checks that query is valid in compile time.

impl<R> IntoQuery for RelatesTo<Read<R>>

where R: Relation + 'static,

fn into_query(self) -> Self

Converts into query.

impl<R> IntoQuery for RelatesTo<Write<R>>

where R: Relation,

fn into_query(self) -> Self

Converts into query.

impl<R> Query for RelatesTo<Read<R>>

where R: Relation,

const MUTABLE: bool = false

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

const FILTERS_ENTITIES: bool = true

Set to true if query filters individual entities.

type Item<'a> = &'a R

Item type this query type yields.

type Fetch<'a> = FetchRelatesToRead<'a, R>

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, ) -> FetchRelatesToRead<'a, R>

Fetches data from one archetype.

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<R> Query for RelatesTo<Write<R>>

where R: Relation,

const MUTABLE: bool = true

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

const FILTERS_ENTITIES: bool = true

Set to true if query filters individual entities.

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

Item type this query type yields.

type Fetch<'a> = FetchRelatesToWrite<'a, R>

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, ) -> FetchRelatesToWrite<'a, R>

Fetches data from one archetype.

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<R> Copy for RelatesTo<R>

impl<R> SendQuery for RelatesTo<Read<R>>

where R: Relation + Sync,

impl<R> SendQuery for RelatesTo<Write<R>>

where R: Relation + Send,