Struct bevy_ecs::change_detection::NonSendMut
source · pub struct NonSendMut<'a, T: ?Sized + 'static> { /* private fields */ }
Expand description
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.
Panics
Panics when used as a SystemParameter
if the resource does not exist.
Use Option<NonSendMut<T>>
instead if the resource might not always exist.
Implementations§
source§impl<'a, T: ?Sized> NonSendMut<'a, T>
impl<'a, T: ?Sized> NonSendMut<'a, T>
sourcepub fn into_inner(self) -> &'a mut T
pub fn into_inner(self) -> &'a mut T
Consume self
and return a mutable reference to the
contained value while marking self
as “changed”.
sourcepub fn map_unchanged<U: ?Sized>(
self,
f: impl FnOnce(&mut T) -> &mut U
) -> Mut<'a, U>
pub fn map_unchanged<U: ?Sized>(
self,
f: impl FnOnce(&mut T) -> &mut U
) -> Mut<'a, U>
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 DetectChanges::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 translation = transform.map_unchanged(|t| &mut t.translation);
// Only reset the translation if it isn't already zero;
my_utils::set_if_not_equal(translation, Vec2::ZERO);
}
}
Trait Implementations§
source§impl<'a, T> AsMut<T> for NonSendMut<'a, T>
impl<'a, T> AsMut<T> for NonSendMut<'a, T>
source§impl<'a, T> AsRef<T> for NonSendMut<'a, T>
impl<'a, T> AsRef<T> for NonSendMut<'a, T>
source§impl<'a, T: ?Sized> Deref for NonSendMut<'a, T>
impl<'a, T: ?Sized> Deref for NonSendMut<'a, T>
source§impl<'a, T: ?Sized> DerefMut for NonSendMut<'a, T>
impl<'a, T: ?Sized> DerefMut for NonSendMut<'a, T>
source§impl<'a, T: ?Sized> DetectChanges for NonSendMut<'a, T>
impl<'a, T: ?Sized> DetectChanges for NonSendMut<'a, T>
source§fn is_changed(&self) -> bool
fn is_changed(&self) -> bool
true
if this value was added or mutably dereferenced after the system last ran.source§fn set_changed(&mut self)
fn set_changed(&mut self)
source§fn last_changed(&self) -> u32
fn last_changed(&self) -> u32
source§fn set_last_changed(&mut self, last_change_tick: u32)
fn set_last_changed(&mut self, last_change_tick: u32)
source§fn bypass_change_detection(&mut self) -> &mut Self::Inner
fn bypass_change_detection(&mut self) -> &mut Self::Inner
source§impl<'a, T: 'static> From<NonSendMut<'a, T>> for Mut<'a, T>
impl<'a, T: 'static> From<NonSendMut<'a, T>> for Mut<'a, T>
source§fn from(other: NonSendMut<'a, T>) -> Mut<'a, T>
fn from(other: NonSendMut<'a, T>) -> Mut<'a, T>
Convert this NonSendMut
into a Mut
. This allows keeping the change-detection feature of Mut
while losing the specificity of NonSendMut
.
source§impl<'a, T> From<NonSendMut<'a, T>> for NonSend<'a, T>
impl<'a, T> From<NonSendMut<'a, T>> for NonSend<'a, T>
source§fn from(nsm: NonSendMut<'a, T>) -> Self
fn from(nsm: NonSendMut<'a, T>) -> Self
source§impl<'a, T: 'static> SystemParam for NonSendMut<'a, T>
impl<'a, T: 'static> SystemParam for NonSendMut<'a, T>
Auto Trait Implementations§
impl<'a, T: ?Sized> RefUnwindSafe for NonSendMut<'a, T>where
T: RefUnwindSafe,
impl<'a, T: ?Sized> Send for NonSendMut<'a, T>where
T: Send,
impl<'a, T: ?Sized> Sync for NonSendMut<'a, T>where
T: Sync,
impl<'a, T: ?Sized> Unpin for NonSendMut<'a, T>
impl<'a, T> !UnwindSafe for NonSendMut<'a, T>
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresource§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read moresource§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more