Skip to main content

Res

Struct Res 

Source
pub struct Res<'w, T: Resource> { /* private fields */ }
Expand description

Shared reference to a resource in World.

Analogous to Bevy’s Res<T>.

Appears in handler function signatures to declare a read dependency. Derefs to the inner value transparently.

§Cloning

Res<T> is Copy + Clone regardless of T — the wrapped reference is &T, which is always Copy. To clone the inner value, use (*res).clone() or res.to_owned(). Calling res.clone() returns Res<T>, not T — same shadowing pattern as Bevy’s Res<T>.

For exclusive write access, use ResMut<T>. For optional read access (no panic if unregistered), use Option<Res<T>>.

Construction is pub(crate) — only the dispatch layer creates these.

Trait Implementations§

Source§

impl<T: Resource> Clone for Res<'_, T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Resource> Debug for Res<'_, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Resource> Deref for Res<'_, T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T: Resource> Param for Res<'_, T>

Source§

type State = ResourceId

Opaque state cached at build time (e.g. ResourceId). Read more
Source§

type Item<'w> = Res<'w, T>

The item produced at dispatch time.
Source§

fn init(registry: &Registry) -> ResourceId

Resolve state from the registry. Called once at build time. Read more
Source§

unsafe fn fetch<'w>(world: &'w World, state: &'w mut ResourceId) -> Res<'w, T>

Fetch the item using cached state. Read more
Source§

fn resource_id(state: &ResourceId) -> Option<ResourceId>

The ResourceId this param accesses, if any. Read more
Source§

impl<T: Resource> Copy for Res<'_, T>

Auto Trait Implementations§

§

impl<'w, T> Freeze for Res<'w, T>

§

impl<'w, T> RefUnwindSafe for Res<'w, T>
where T: RefUnwindSafe,

§

impl<'w, T> Send for Res<'w, T>
where T: Sync,

§

impl<'w, T> Sync for Res<'w, T>
where T: Sync,

§

impl<'w, T> Unpin for Res<'w, T>

§

impl<'w, T> UnsafeUnpin for Res<'w, T>

§

impl<'w, T> UnwindSafe for Res<'w, T>
where T: RefUnwindSafe,

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.