Struct legion::Read

pub struct Read<T>(_);

Reads a single entity data component type from a chunk.

Trait Implementations

impl<T: Clone> Clone for Read<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Read<T>

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

Formats the value using the given formatter.

impl<T> Default for Read<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Component> DefaultFilter for Read<T>

type Filter = EntityFilterTuple<ComponentFilter<T>, Passthrough>

The filter constructed.

impl<'a, T: Resource> ResourceSet<'a> for Read<T>

type Result = AtomicRef<'a, T>

The resource reference returned during a fetch.

unsafe fn fetch_unchecked(resources: &'a UnsafeResources) -> Self::Result

Fetches all defined resources, without checking mutability.

fn fetch_mut(resources: &'a mut Resources) -> Self::Result

Fetches all defined resources.

fn fetch(resources: &'a Resources) -> Self::Result where
    Self: ReadOnly, 

Fetches all defined resources.

impl<'data, T: Component> View<'data> for Read<T>

type Element = <Self::Fetch as IntoIndexableIter>::Item

The type of component references returned.

type Fetch = ReadFetch<'data, T>

The fetch type yielded for each archetype.

type Iter = ReadIter<'data, T>

The iterator type which pulls entity data out of a world.

type Read = [ComponentTypeId; 1]

Contains the type IDs read by the view.

type Write = [ComponentTypeId; 0]

Contains the type IDs written by the view.

fn validate()

Determines if this view type is valid. Panics if checks fail.

fn validate_access(access: &ComponentAccess<'_>) -> bool

Returns true if the given component access includes all permissions required by the view.

fn reads_types() -> Self::Read

Returns the component types read by the view.

fn writes_types() -> Self::Write

Returns the component types written to by the view.

fn reads<D: Component>() -> bool

Returns true if the view reads the specified data type.

fn writes<D: Component>() -> bool

Returns true if the view writes to the specified data type.

fn requires_permissions() -> Permissions<ComponentTypeId>

Returns a permissions struct declaring the component accesses required by the view.

unsafe fn fetch(
    components: &'data Components,
    _: &'data [Archetype],
    query: QueryResult<'data>
) -> Self::Iter

Creates an iterator which will yield slices of entity data for each archetype.

impl<T: Copy> Copy for Read<T>

impl<T> Send for Read<T>

impl<T: Sync> Sync for Read<T>