Struct shred::Read

pub struct Read<'a, T: 'a, F = DefaultProvider> { /* 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>) -> Self

Converts to this type from the input type.

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) -> Self

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.