Struct oxygengine_core::ecs::prelude::Read

pub struct Read<'a, T, F = DefaultProvider> where
    T: 'a + 'a,  { /* fields omitted */ }

Allows to fetch a resource in a system immutably.

If the resource isn't strictly required, you should use Option<Read<T>>.

Type parameters

• T: The type of the resource
• F: The setup handler (default: DefaultProvider)

Trait Implementations

impl<'a, 'b, T> Join for &'a Read<'b, T, DefaultProvider> where
    T: Resource,
    &'a T: Join, 

type Type = <&'a T as Join>::Type

Type of joined components.

type Value = <&'a T as Join>::Value

Type of joined storages.

type Mask = <&'a T as Join>::Mask

Type of joined bit mask.

unsafe fn open(
    self
) -> (<&'a Read<'b, T, DefaultProvider> as Join>::Mask, <&'a Read<'b, T, DefaultProvider> as Join>::Value)

Open this join by returning the mask and the storages.

unsafe fn get(
    v: &mut <&'a Read<'b, T, DefaultProvider> as Join>::Value,
    i: u32
) -> <&'a Read<'b, T, DefaultProvider> as Join>::Type

Get a joined component value by a given index.

fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

Important traits for JoinIter<J>

impl<J> Iterator for JoinIter<J> where
    J: Join,  type Item = <J as Join>::Type;

fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

fn maybe(self) -> MaybeJoin<Self>

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

impl<'a, 'b, T> Join for &'a Read<'b, T, PanicHandler> where
    T: Resource,
    &'a T: Join, 

type Type = <&'a T as Join>::Type

Type of joined components.

type Value = <&'a T as Join>::Value

Type of joined storages.

type Mask = <&'a T as Join>::Mask

Type of joined bit mask.

unsafe fn open(
    self
) -> (<&'a Read<'b, T, PanicHandler> as Join>::Mask, <&'a Read<'b, T, PanicHandler> as Join>::Value)

Open this join by returning the mask and the storages.

unsafe fn get(
    v: &mut <&'a Read<'b, T, PanicHandler> as Join>::Value,
    i: u32
) -> <&'a Read<'b, T, PanicHandler> as Join>::Type

Get a joined component value by a given index.

fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

Important traits for JoinIter<J>

impl<J> Iterator for JoinIter<J> where
    J: Join,  type Item = <J as Join>::Type;

fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

fn maybe(self) -> MaybeJoin<Self>

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

impl<'a, T, F> From<Fetch<'a, T>> for Read<'a, T, F>

fn from(inner: Fetch<'a, T>) -> Read<'a, T, F>

Performs the conversion.

impl<'a, T, F> SystemData<'a> for Read<'a, T, F> where
    F: SetupHandler<T>,
    T: Resource, 

fn setup(res: &mut Resources)

Sets up the system data for fetching it from the Resources.

fn fetch(res: &'a Resources) -> Read<'a, T, F>

Fetches the system data from Resources. Note that this is only specified for one concrete lifetime 'a, you need to implement the SystemData trait for every possible lifetime.

fn reads() -> Vec<ResourceId>

Returns all read dependencies as fetched from Self::fetch.

fn writes() -> Vec<ResourceId>

Returns all write dependencies as fetched from Self::fetch.

impl<'a, T, F> Deref for Read<'a, T, F> where
    T: Resource, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.