Struct Read

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

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, 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.

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

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

Converts to this type from the input type.

impl<'a, 'b, T> Join for &'a Read<'b, T>

where &'a T: Join, T: Resource,

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) -> (Self::Mask, Self::Value)

Open this join by returning the mask and the storages.

unsafe fn get(v: &mut Self::Value, i: Index) -> Self::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 to go through all indices which is usually not what is wanted and will kill performance.

fn join(self) -> JoinIter<Self>

where Self: Sized,

Create a joined iterator over the contents.

impl<'a, 'b, T> LendJoin for &'a Read<'b, T>

where &'a T: LendJoin, T: Resource,

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

Type of joined storages.

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

Type of joined bit mask.

unsafe fn open(self) -> (Self::Mask, Self::Value)

Open this join by returning the mask and the storages.

unsafe fn get<'next>( v: &'next mut Self::Value, i: Index, ) -> <Self as LendJoinඞType<'next>>::T

Get a joined component value by a given index.

fn is_unconstrained() -> bool

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

fn lend_join(self) -> JoinLendIter<Self>

where Self: Sized,

Create a joined lending iterator over the contents.

fn maybe(self) -> MaybeJoin<Self>

where Self: Sized,

Returns a structure that implements Join/LendJoin/MaybeJoin if the contained T does and that yields all indices, returning None for all missing elements and Some(T) for found elements.

impl<'a, 'b, T> ParJoin for &'a Read<'b, T>

where &'a T: ParJoin, T: Resource,

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

Type of joined components.

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

Type of joined storages.

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

Type of joined bit mask.

unsafe fn open(self) -> (Self::Mask, Self::Value)

Open this join by returning the mask and the storages.

unsafe fn get(v: &Self::Value, i: Index) -> Self::Type

Get a joined component value by a given index.

fn is_unconstrained() -> bool

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

fn par_join(self) -> JoinParIter<Self>

where Self: Sized,

Create a joined parallel iterator over the contents.

impl<'a, T, F> SystemData<'a> for Read<'a, T, F>

where T: Resource, F: SetupHandler<T>,

fn setup(world: &mut World)

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

fn fetch(world: &'a World) -> Read<'a, T, F>

Fetches the system data from World. 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, 'b, T> RepeatableLendGet for &'a Read<'b, T>

where &'a T: RepeatableLendGet, T: Resource,