Read

Struct Read 

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

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§

Source§

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

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn setup(world: &mut World)

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

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.
Source§

fn reads() -> Vec<ResourceId>

Returns all read dependencies as fetched from Self::fetch. Read more
Source§

fn writes() -> Vec<ResourceId>

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

Auto Trait Implementations§

§

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

§

impl<'a, T, F = DefaultProvider> !RefUnwindSafe for Read<'a, T, F>

§

impl<'a, T, F> Send for Read<'a, T, F>
where F: Send, T: Sync,

§

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

§

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

§

impl<'a, T, F = DefaultProvider> !UnwindSafe for Read<'a, T, F>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<'a, T> DynamicSystemData<'a> for T
where T: SystemData<'a>,

Source§

type Accessor = StaticAccessor<T>

The accessor of the SystemData, which specifies the read and write dependencies and does the fetching.
Source§

fn setup(_: &StaticAccessor<T>, world: &mut World)

Sets up World for fetching this system data.
Source§

fn fetch(_: &StaticAccessor<T>, world: &'a World) -> T

Creates a new resource bundle by fetching the required resources from the World struct. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Resource for T
where T: Any + Send + Sync,