Struct hecs::Ref

pub struct Ref<'a, T: ?Sized> { /* private fields */ }

Shared borrow of an entity’s component

Implementations

impl<'a, T: ?Sized> Ref<'a, T>

pub fn map<U: ?Sized, F>(orig: Ref<'a, T>, f: F) -> Ref<'a, U>

where F: FnOnce(&T) -> &U,

Transform the Ref<'_, T> to point to a part of the borrowed data, e.g. a struct field.

The Ref<'_, T> is already borrowed, so this cannot fail.

Examples

struct Component {
    member: i32,
}

let component_ref = entity_ref.get::<&Component>()
    .expect("Entity does not contain an instance of \"Component\"");
let member_ref = Ref::map(component_ref, |component| &component.member);
println!("member = {:?}", *member_ref);

Trait Implementations

impl<'a, T: ?Sized> Clone for Ref<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: ?Sized + Debug> Debug for Ref<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: ?Sized> Deref for Ref<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: ?Sized + Display> Display for Ref<'a, T>

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

Formats the value using the given formatter.

impl<T: ?Sized + Sync> Send for Ref<'_, T>

impl<T: ?Sized + Sync> Sync for Ref<'_, T>