Struct bevy::ecs::change_detection::MutUntyped

pub struct MutUntyped<'a> { /* private fields */ }

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

impl<'a> MutUntyped<'a>

pub fn into_inner(self) -> PtrMut<'a, Aligned>

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.

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.

pub fn as_mut(&mut self) -> PtrMut<'_, Aligned>

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.

pub fn as_ref(&self) -> Ptr<'_, Aligned>

Returns an immutable pointer to the value without taking ownership.

pub unsafe fn with_type<T>(self) -> Mut<'a, T>

Transforms this MutUntyped into a Mut<T> with the same lifetime.

Safety

• T must be the erased pointee type for this MutUntyped.

Trait Implementations

impl Debug for MutUntyped<'_>

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

Formats the value using the given formatter.

impl<'a> DetectChanges for MutUntyped<'a>

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 after the system last ran.

fn last_changed(&self) -> u32

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

impl<'a> DetectChangesMut for MutUntyped<'a>

type Inner = PtrMut<'a, Aligned>

The type contained within this smart pointer

fn set_changed(&mut self)

Flags this value as having been changed.

fn set_last_changed(&mut self, last_changed: u32)

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

fn bypass_change_detection( &mut self ) -> &mut <MutUntyped<'a> as DetectChangesMut>::Inner

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