Struct rfw::ecs::query::ReadFetch

pub struct ReadFetch<T> { /* fields omitted */ }

Trait Implementations

impl<'w, T> Fetch<'w> for ReadFetch<T> where
    T: Component, 

type Item = &'w T

type State = ReadState<T>

pub fn is_dense(&self) -> bool

Returns true if (and only if) every table of every archetype matched by this Fetch contains all of the matched components. This is used to select a more efficient “table iterator” for “dense” queries. If this returns true, Fetch::set_table and Fetch::table_fetch will be called for iterators If this returns false, Fetch::set_archetype and Fetch::archetype_fetch will be called for iterators

pub unsafe fn init(
    world: &World,
    state: &<ReadFetch<T> as Fetch<'w>>::State,
    _last_change_tick: u32,
    _change_tick: u32
) -> ReadFetch<T>

Creates a new instance of this fetch.

pub unsafe fn set_archetype(
    &mut self,
    state: &<ReadFetch<T> as Fetch<'w>>::State,
    archetype: &Archetype,
    tables: &Tables
)

Adjusts internal state to account for the next Archetype. This will always be called on archetypes that match this Fetch

pub unsafe fn set_table(
    &mut self,
    state: &<ReadFetch<T> as Fetch<'w>>::State,
    table: &Table
)

Adjusts internal state to account for the next Table. This will always be called on tables that match this Fetch

pub unsafe fn archetype_fetch(
    &mut self,
    archetype_index: usize
) -> <ReadFetch<T> as Fetch<'w>>::Item

Fetch Self::Item for the given archetype_index in the current Archetype. This must always be called after Fetch::set_archetype with an archetype_index in the range of the current Archetype

pub unsafe fn table_fetch(
    &mut self,
    table_row: usize
) -> <ReadFetch<T> as Fetch<'w>>::Item

Fetch Self::Item for the given table_row in the current Table. This must always be called after Fetch::set_table with a table_row in the range of the current Table

impl<T> ReadOnlyFetch for ReadFetch<T>

SAFE: access is read only