Struct bevy_ecs::Ref

pub struct Ref<'a, T> where
    T: Component,  { /* fields omitted */ }

Shared borrow of an entity's component

Implementations

impl<'a, T> Ref<'a, T> where
    T: Component, 

pub unsafe fn new(
    archetype: &'a Archetype,
    index: usize
) -> Result<Ref<'a, T>, MissingComponent>

Creates a new entity component borrow

Safety

• the index of the component must be valid

Trait Implementations

impl<'a, T> Clone for Ref<'a, T> where
    T: Component + Clone, 

fn clone(&self) -> Ref<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Ref<'a, T> where
    T: Component + Debug, 

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

Formats the value using the given formatter.

impl<'a, T> Deref for Ref<'a, T> where
    T: Component, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T> Drop for Ref<'a, T> where
    T: Component, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'_, T> Send for Ref<'_, T> where
    T: Component, 

impl<'_, T> Sync for Ref<'_, T> where
    T: Component,