Struct InRef

pub struct InRef<'i, T>(pub &'i T)
where
    T: ?Sized;

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

This is similar to In but takes a reference to a value instead of the value itself. See InMut for the mutable version.

See SystemInput to learn more about system inputs in general.

Examples

Here is a simple example of a system that logs the passed in message.

#[derive(Resource, Default)]
struct Log(String);

fn log(InRef(msg): InRef<str>, mut log: ResMut<Log>) {
    writeln!(log.0, "{}", msg).unwrap();
}

let mut world = World::new();
world.init_resource::<Log>();
let mut log_system = IntoSystem::into_system(log);
log_system.initialize(&mut world);

log_system.run("Hello, world!", &mut world);

Tuple Fields

0: &'i T

Trait Implementations

impl<'i, T> Debug for InRef<'i, 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 InRef<'i, T>

where T: ?Sized,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

where T: 'static + ?Sized,

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

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

type Inner<'i> = &'i T

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

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

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