Struct bevy_ecs::change_detection::MutUntyped
source · pub struct MutUntyped<'w> { /* private fields */ }
Expand description
Unique mutable borrow of resources or an entity’s component.
Similar to Mut
, but not generic over the component type, instead
exposing the raw pointer as a *mut ()
.
Usually you don’t need to use this and can instead use the APIs returning a
Mut
, but in situations where the types are not known at compile time
or are defined outside of rust this can be used.
Implementations§
source§impl<'w> MutUntyped<'w>
impl<'w> MutUntyped<'w>
sourcepub fn into_inner(self) -> PtrMut<'w>
pub fn into_inner(self) -> PtrMut<'w>
Returns the pointer to the value, marking it as changed.
In order to avoid marking the value as changed, you need to call bypass_change_detection
.
sourcepub fn reborrow(&mut self) -> MutUntyped<'_>
pub fn reborrow(&mut self) -> MutUntyped<'_>
Returns a MutUntyped
with a smaller lifetime.
This is useful if you have &mut MutUntyped
, but you need a MutUntyped
.
sourcepub fn has_changed_since(&self, tick: Tick) -> bool
pub fn has_changed_since(&self, tick: Tick) -> bool
Returns true
if this value was changed or mutably dereferenced
either since a specific change tick.
sourcepub fn as_mut(&mut self) -> PtrMut<'_>
pub fn as_mut(&mut self) -> PtrMut<'_>
Returns a pointer to the value without taking ownership of this smart pointer, marking it as changed.
In order to avoid marking the value as changed, you need to call bypass_change_detection
.
sourcepub fn as_ref(&self) -> Ptr<'_>
pub fn as_ref(&self) -> Ptr<'_>
Returns an immutable pointer to the value without taking ownership.
sourcepub fn map_unchanged<T: ?Sized>(
self,
f: impl FnOnce(PtrMut<'w>) -> &'w mut T
) -> Mut<'w, T>
pub fn map_unchanged<T: ?Sized>( self, f: impl FnOnce(PtrMut<'w>) -> &'w mut T ) -> Mut<'w, T>
Turn this MutUntyped
into a Mut
by mapping the inner PtrMut
to another value,
without flagging a change.
This function is the untyped equivalent of Mut::map_unchanged
.
You should never modify the argument passed to the closure – if you want to modify the data without flagging a change, consider using bypass_change_detection
to make your intent explicit.
If you know the type of the value you can do
// SAFETY: ptr is of type `u8`
mut_untyped.map_unchanged(|ptr| unsafe { ptr.deref_mut::<u8>() });
If you have a ReflectFromPtr
that you know belongs to this MutUntyped
,
you can do
// SAFETY: from the context it is known that `ReflectFromPtr` was made for the type of the `MutUntyped`
mut_untyped.map_unchanged(|ptr| unsafe { reflect_from_ptr.as_reflect_mut(ptr) });
sourcepub unsafe fn with_type<T>(self) -> Mut<'w, T>
pub unsafe fn with_type<T>(self) -> Mut<'w, T>
Transforms this MutUntyped
into a Mut<T>
with the same lifetime.
§Safety
T
must be the erased pointee type for thisMutUntyped
.
Trait Implementations§
source§impl Debug for MutUntyped<'_>
impl Debug for MutUntyped<'_>
source§impl<'w> DetectChanges for MutUntyped<'w>
impl<'w> DetectChanges for MutUntyped<'w>
source§fn is_changed(&self) -> bool
fn is_changed(&self) -> bool
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. Read moresource§fn last_changed(&self) -> Tick
fn last_changed(&self) -> Tick
source§impl<'w> DetectChangesMut for MutUntyped<'w>
impl<'w> DetectChangesMut for MutUntyped<'w>
source§fn set_changed(&mut self)
fn set_changed(&mut self)
source§fn set_last_changed(&mut self, last_changed: Tick)
fn set_last_changed(&mut self, last_changed: Tick)
source§fn bypass_change_detection(&mut self) -> &mut Self::Inner
fn bypass_change_detection(&mut self) -> &mut Self::Inner
Auto Trait Implementations§
impl<'w> Freeze for MutUntyped<'w>
impl<'w> RefUnwindSafe for MutUntyped<'w>
impl<'w> !Send for MutUntyped<'w>
impl<'w> !Sync for MutUntyped<'w>
impl<'w> Unpin for MutUntyped<'w>
impl<'w> !UnwindSafe for MutUntyped<'w>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§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.source§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.