Struct NonSendMut

pub struct NonSendMut<'w, T>
where
    T: 'static + ?Sized,
{ /* private fields */ }

Unique borrow of a non-Send resource.

Only Send resources may be accessed with the ResMut SystemParam. In case that the resource does not implement Send, this SystemParam wrapper can be used. This will instruct the scheduler to instead run the system on the main thread so that it doesn’t send the resource over to another thread.

This SystemParam fails validation if non-send resource doesn’t exist. This will cause a panic, but can be configured to do nothing or warn once.

Use Option<NonSendMut<T>> instead if the resource might not always exist.

Implementations

impl<'w, T> NonSendMut<'w, T>

where T: ?Sized,

pub fn into_inner(self) -> &'w mut T

Consume self and return a mutable reference to the contained value while marking self as “changed”.

pub fn reborrow(&mut self) -> Mut<'_, T>

Returns a Mut<> with a smaller lifetime. This is useful if you have &mut NonSendMut <T>, but you need a Mut<T>.

pub fn map_unchanged<U>(self, f: impl FnOnce(&mut T) -> &mut U) -> Mut<'w, U>

where U: ?Sized,

Maps to an inner value by applying a function to the contained reference, without flagging a change.

You should never modify the argument passed to the closure – if you want to modify the data without flagging a change, consider using DetectChangesMut::bypass_change_detection to make your intent explicit.

// When run, zeroes the translation of every entity.
fn reset_positions(mut transforms: Query<&mut Transform>) {
    for transform in &mut transforms {
        // We pinky promise not to modify `t` within the closure.
        // Breaking this promise will result in logic errors, but will never cause undefined behavior.
        let mut translation = transform.map_unchanged(|t| &mut t.translation);
        // Only reset the translation if it isn't already zero;
        translation.set_if_neq(Vec2::ZERO);
    }
}

pub fn filter_map_unchanged<U>( self, f: impl FnOnce(&mut T) -> Option<&mut U>, ) -> Option<Mut<'w, U>>

where U: ?Sized,

Optionally maps to an inner value by applying a function to the contained reference. This is useful in a situation where you need to convert a Mut<T> to a Mut<U>, but only if T contains U.

As with map_unchanged, you should never modify the argument passed to the closure.

pub fn try_map_unchanged<U, E>( self, f: impl FnOnce(&mut T) -> Result<&mut U, E>, ) -> Result<Mut<'w, U>, E>

where U: ?Sized,

Optionally maps to an inner value by applying a function to the contained reference, returns an error on failure. This is useful in a situation where you need to convert a Mut<T> to a Mut<U>, but only if T contains U.

As with map_unchanged, you should never modify the argument passed to the closure.

pub fn as_deref_mut(&mut self) -> Mut<'_, <T as Deref>::Target>

where T: DerefMut,

Allows you access to the dereferenced value of this pointer without immediately triggering change detection.

Trait Implementations

impl<'w, T> AsMut<T> for NonSendMut<'w, T>

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

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

impl<'w, T> AsRef<T> for NonSendMut<'w, T>

fn as_ref(&self) -> &T

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

impl<'w, T> Debug for NonSendMut<'w, T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<'w, T> Deref for NonSendMut<'w, T>

where T: ?Sized,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'w, T> DerefMut for NonSendMut<'w, T>

where T: ?Sized,

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

Mutably dereferences the value.

impl<'w, T> DetectChanges for NonSendMut<'w, T>

where T: ?Sized,

fn is_added(&self) -> bool

Returns true if this value was added after the system last ran.

fn is_changed(&self) -> bool

Returns true if this value was added or mutably dereferenced either since the last time the system ran or, if the system never ran, since the beginning of the program.

fn last_changed(&self) -> Tick

Returns the change tick recording the time this data was most recently changed.

fn added(&self) -> Tick

Returns the change tick recording the time this data was added.

fn changed_by(&self) -> MaybeLocation

The location that last caused this to change.

impl<'w, T> DetectChangesMut for NonSendMut<'w, T>

where T: ?Sized,

type Inner = T

The type contained within this smart pointer

fn set_changed(&mut self)

Flags this value as having been changed.

fn set_added(&mut self)

Flags this value as having been added.

fn set_last_changed(&mut self, last_changed: Tick)

Manually sets the change tick recording the time when this data was last mutated.

fn set_last_added(&mut self, last_added: Tick)

Manually sets the added tick recording the time when this data was last added.

fn bypass_change_detection( &mut self, ) -> &mut <NonSendMut<'w, T> as DetectChangesMut>::Inner

Manually bypasses change detection, allowing you to mutate the underlying value without updating the change tick.

fn set_if_neq(&mut self, value: Self::Inner) -> bool

where Self::Inner: Sized + PartialEq,

Overwrites this smart pointer with the given value, if and only if *self != value. Returns true if the value was overwritten, and returns false if it was not.

fn replace_if_neq(&mut self, value: Self::Inner) -> Option<Self::Inner>

where Self::Inner: Sized + PartialEq,

Overwrites this smart pointer with the given value, if and only if *self != value, returning the previous value if this occurs.

fn clone_from_if_neq<T>(&mut self, value: &T) -> bool

where T: ToOwned<Owned = Self::Inner> + ?Sized, Self::Inner: PartialEq<T>,

Overwrites this smart pointer with a clone of the given value, if and only if *self != value. Returns true if the value was overwritten, and returns false if it was not.

impl<'a, T> From<NonSendMut<'a, T>> for NonSend<'a, T>

fn from(nsm: NonSendMut<'a, T>) -> NonSend<'a, T>

Converts to this type from the input type.

impl<'w, T> From<NonSendMut<'w, T>> for Mut<'w, T>

where T: 'static,

fn from(other: NonSendMut<'w, T>) -> Mut<'w, T>

Convert this NonSendMut into a Mut. This allows keeping the change-detection feature of Mut while losing the specificity of NonSendMut.

impl<'a, T> SystemParam for NonSendMut<'a, T>

where T: 'static,

type State = ComponentId

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

type Item<'w, 's> = NonSendMut<'w, T>

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) -> <NonSendMut<'a, T> as SystemParam>::State

Creates a new instance of this param’s State.

fn init_access( _: &<NonSendMut<'a, T> as SystemParam>::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, _world: &mut World, )

Registers any World access used by this SystemParam

unsafe fn validate_param( _: &mut <NonSendMut<'a, T> as SystemParam>::State, _system_meta: &SystemMeta, world: UnsafeWorldCell<'_>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param.

unsafe fn get_param<'w, 's>( _: &'s mut <NonSendMut<'a, T> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> <NonSendMut<'a, T> as SystemParam>::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.