Struct ResMut

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

Resource borrowed mutably. Derefs to the resource type.

Example

let mut world = World::new();

world.insert_resource(42i32);
let mut value: ResMut<i32> = world.expect_resource_mut();
*value = 11;

Implementations

impl<'a, T> ResMut<'a, T>

where T: ?Sized,

pub fn leak(r: ResMut<'a, T>) -> &'a mut T

Convert into a mutable reference to the underlying data. This function will consume the ResMut and keep data borrowed. See World::undo_resource_leaks to undo all leaks.

This is an associated function that needs to be used as ResMut::leak(…). A method would interfere with methods of the same name on the resource used through Deref.

Example

let mut world = World::new();
world.insert_resource(42i32);

// Leaking reference to resource causes it to stay borrowed.
let value: &mut i32 = ResMut::leak(world.get_resource_mut().unwrap());

*value == 11;

let mut world = World::new();
world.insert_resource(42i32);

// Leaking reference to resource causes it to stay borrowed.
let value: &mut i32 = ResMut::leak(world.get_resource_mut().unwrap());

// Immutable borrow panics.
world.get_resource::<i32>();

Trait Implementations

impl<'a, T, U> AsMut<U> for ResMut<'a, T>

where T: AsMut<U> + ?Sized,

fn as_mut(&mut self) -> &mut U

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a, T, U> AsRef<U> for ResMut<'a, T>

where T: AsRef<U> + ?Sized,

fn as_ref(&self) -> &U

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, T> Borrow<T> for ResMut<'a, T>

where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T> BorrowMut<T> for ResMut<'a, T>

where T: ?Sized,

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

Mutably borrows from an owned value.

impl<T> Debug for ResMut<'_, T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<'a, T> Deref for ResMut<'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 ResMut<'a, T>

where T: ?Sized,

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

Mutably dereferences the value.

impl<T> Display for ResMut<'_, T>

where T: Display + ?Sized,

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

Formats the value using the given formatter.

impl<'a, T> FnArg for ResMut<'a, T>

where T: Send + 'static,

type State = ResMutState<T>

State for an argument that is stored between calls to function-system.

impl<'a, T> Hash for ResMut<'a, T>

where T: Hash + ?Sized,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T, U> PartialEq<U> for ResMut<'a, T>

where T: PartialEq<U> + ?Sized,

fn eq(&self, other: &U) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T, U> PartialOrd<U> for ResMut<'a, T>

where T: PartialOrd<U> + ?Sized,

fn partial_cmp(&self, other: &U) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.