Struct oxygengine::prelude::RefMut

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

Unique borrow of an entity’s component

Implementations

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

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

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> Debug for RefMut<'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 RefMut<'a, T>where T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Mutably dereferences the value.

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

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