Struct Ref

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

Shared borrow of an entity’s component

Implementations

impl<'a, T> Ref<'a, T>

where T: ?Sized,

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

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

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> Clone for Ref<'a, T>

where T: ?Sized,

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: Debug + ?Sized,

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: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T> Display for Ref<'a, T>

where T: Display + ?Sized,

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

Formats the value using the given formatter.

impl<T> Send for Ref<'_, T>

where T: Sync + ?Sized,

impl<T> Sync for Ref<'_, T>

where T: Sync + ?Sized,