Struct hecs::RefMut

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

Unique borrow of an entity’s component

Implementations

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

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

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

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

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

Examples

struct Component {
    member: i32,
}

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: ?Sized> DerefMut for RefMut<'a, T>

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

Mutably dereferences the value.

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

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

Formats the value using the given formatter.

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

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