Struct SystemName 

pub struct SystemName(/* private fields */);

SystemParam that returns the name of the system which it is used in.

This is not a reliable identifier, it is more so useful for debugging or logging.

Examples

#[derive(SystemParam)]
struct Logger {
    system_name: SystemName,
}

impl Logger {
    fn log(&mut self, message: &str) {
        eprintln!("{}: {}", self.system_name, message);
    }
}

fn system1(mut logger: Logger) {
    // Prints: "crate_name::mod_name::system1: Hello".
    logger.log("Hello");
}

Implementations

impl SystemName

pub fn name(&self) -> DebugName

Gets the name of the system.

Trait Implementations

impl Debug for SystemName

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

Formats the value using the given formatter.

impl Display for SystemName

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

Formats the value using the given formatter.

impl ExclusiveSystemParam for SystemName

type State = ()

Used to store data which persists across invocations of a system.

type Item<'s> = SystemName

The item type returned when constructing this system param. See SystemParam::Item.

fn init(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State

Creates a new instance of this param’s State.

fn get_param<'s>( _state: &'s mut Self::State, system_meta: &SystemMeta, ) -> Self::Item<'s>

Creates a parameter to be passed into an ExclusiveSystemParamFunction.

impl From<SystemName> for DebugName

fn from(value: SystemName) -> Self

Converts to this type from the input type.

impl SystemParam for SystemName

type State = ()

Used to store data which persists across invocations of a system.

type Item<'w, 's> = SystemName

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(_world: &mut World) -> Self::State

Creates a new instance of this param’s State.

fn init_access( _state: &Self::State, _system_meta: &mut SystemMeta, _component_access_set: &mut FilteredAccessSet, _world: &mut World, )

Registers any World access used by this SystemParam

unsafe fn get_param<'w, 's>( _state: &'s mut Self::State, system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, _change_tick: Tick, ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction.

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn validate_param( state: &mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

impl ReadOnlySystemParam for SystemName