Struct ReceiverMut 

pub struct ReceiverMut<'a, E, Q = NullReceiverQuery>
where
    E: Event,
    Q: ReceiverQuery + 'static,
{
    pub event: EventMut<'a, E>,
    pub query: <Q as ReceiverQuery>::Item<'a>,
}

Like Receiver, but provides mutable access to the received event. Prefer Receiver if mutable access is not needed.

For more information, see the relevant tutorial chapter.

Fields

event: EventMut<'a, E>

A mutable reference to the received event.

query: <Q as ReceiverQuery>::Item<'a>

The result of the query. This field is meaningless if E is not a targeted event.

Trait Implementations

impl<'a, E> Debug for ReceiverMut<'a, E>

where E: GlobalEvent, <E as Event>::This<'a>: Debug,

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

Formats the value using the given formatter.

impl<'a, E, Q> Debug for ReceiverMut<'a, E, Q>

where E: TargetedEvent, <E as Event>::This<'a>: Debug, Q: Query, <Q as Query>::Item<'a>: Debug,

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

Formats the value using the given formatter.

impl<E> HandlerParam for ReceiverMut<'_, E>

where E: GlobalEvent<Mutability = Mutable> + Event,

type State = ()

Persistent data stored in the handler.

type This<'a> = ReceiverMut<'a, E>

The type produced by this handler param. This must be the type of Self but with the lifetime of 'a.

fn init( world: &mut World, config: &mut HandlerConfig, ) -> Result<<ReceiverMut<'_, E> as HandlerParam>::State, InitError>

Initializes the handler using the input World and HandlerConfig.

unsafe fn get<'a>( _state: &'a mut <ReceiverMut<'_, E> as HandlerParam>::State, _info: &'a HandlerInfo, event_ptr: EventPtr<'a>, _target_location: EntityLocation, _world: UnsafeWorldCell<'a>, ) -> <ReceiverMut<'_, E> as HandlerParam>::This<'a>

Obtains a new instance of the handler parameter.

fn refresh_archetype( _state: &mut <ReceiverMut<'_, E> as HandlerParam>::State, _arch: &Archetype, )

Refresh an archetype for this handler param. Called whenever Handler::refresh_archetype is called.

fn remove_archetype( _state: &mut <ReceiverMut<'_, E> as HandlerParam>::State, _arch: &Archetype, )

Remove the given archetype for this handler param. Called whenever Handler::remove_archetype is called.

impl<E, Q> HandlerParam for ReceiverMut<'_, E, Q>

where E: TargetedEvent<Mutability = Mutable> + Event, Q: Query + 'static,

type State = FetcherState<Q>

Persistent data stored in the handler.

type This<'a> = ReceiverMut<'a, E, Q>

The type produced by this handler param. This must be the type of Self but with the lifetime of 'a.

fn init( world: &mut World, config: &mut HandlerConfig, ) -> Result<<ReceiverMut<'_, E, Q> as HandlerParam>::State, InitError>

Initializes the handler using the input World and HandlerConfig.

unsafe fn get<'a>( state: &'a mut <ReceiverMut<'_, E, Q> as HandlerParam>::State, _info: &'a HandlerInfo, event_ptr: EventPtr<'a>, target_location: EntityLocation, _world: UnsafeWorldCell<'a>, ) -> <ReceiverMut<'_, E, Q> as HandlerParam>::This<'a>

Obtains a new instance of the handler parameter.

fn refresh_archetype( state: &mut <ReceiverMut<'_, E, Q> as HandlerParam>::State, arch: &Archetype, )

Refresh an archetype for this handler param. Called whenever Handler::refresh_archetype is called.

fn remove_archetype( state: &mut <ReceiverMut<'_, E, Q> as HandlerParam>::State, arch: &Archetype, )

Remove the given archetype for this handler param. Called whenever Handler::remove_archetype is called.