Struct Relations

pub struct Relations<T: ComponentValue> { /* private fields */ }

Returns an iterator of all relations of the specified type

Trait Implementations

impl<T: Clone + ComponentValue> Clone for Relations<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ComponentValue> Debug for Relations<T>

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

Formats the value using the given formatter.

impl<'w, T> Fetch<'w> for Relations<T>

where T: ComponentValue,

const MUTABLE: bool = false

true if the fetch mutates any component and thus needs a change event

type Prepared = PreparedRelations<'w, T>

The prepared version of the fetch

fn prepare(&self, data: FetchPrepareData<'w>) -> Option<Self::Prepared>

Prepares the fetch for an archetype by acquiring borrows.

fn filter_arch(&self, _: FetchAccessData<'_>) -> bool

Returns true if the archetype matches the fetch

fn access(&self, data: FetchAccessData<'_>, dst: &mut Vec<Access>)

Returns which components and how will be accessed for an archetype.

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

Describes the fetch in a human-readable fashion

fn searcher(&self, _searcher: &mut ArchetypeSearcher)

Returns the required component for the fetch.

fn by_ref(&self) -> RefFetch<'_, Self>

where Self: Sized,

Convert the fetch to a reference type which works with HRTB

impl<'q, T: ComponentValue> FetchItem<'q> for Relations<T>

type Item = RelationsIter<'q, T>

The item yielded by the prepared fetch