Struct InMut

pub struct InMut<'a, T>(pub &'a mut T)
where
    T: ?Sized;

A SystemInput type which denotes that a System receives a mutable reference to a value of type T from its caller.

This is similar to In but takes a mutable reference to a value instead of the value itself. See InRef for the read-only version.

See SystemInput to learn more about system inputs in general.

Examples

Here is a simple example of a system that takes a &mut usize and squares it.

fn square(InMut(input): InMut<usize>) {
    *input *= *input;
}

let mut world = World::new();
let mut square_system = IntoSystem::into_system(square);
square_system.initialize(&mut world);
     
let mut value = 12;
square_system.run(&mut value, &mut world);
assert_eq!(value, 144);

Tuple Fields

0: &'a mut T

Trait Implementations

impl<'a, T> Debug for InMut<'a, T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<'i, T> Deref for InMut<'i, T>

where T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<InMut<'i, T> as Deref>::Target

Dereferences the value.

impl<'i, T> DerefMut for InMut<'i, T>

where T: ?Sized,

fn deref_mut(&mut self) -> &mut <InMut<'i, T> as Deref>::Target

Mutably dereferences the value.

impl<T> SystemInput for InMut<'_, T>

where T: 'static + ?Sized,

type Param<'i> = InMut<'i, T>

The wrapper input type that is defined as the first argument to FunctionSystems.

type Inner<'i> = &'i mut T

The inner input type that is passed to functions that run systems, such as System::run.

fn wrap( this: <InMut<'_, T> as SystemInput>::Inner<'_>, ) -> <InMut<'_, T> as SystemInput>::Param<'_>

Converts a SystemInput::Inner into a SystemInput::Param.