Struct bevy_script_api::script_ref::ReflectPtr

pub struct ReflectPtr { /* private fields */ }

A pointer wrapper with some extra safety information about mutability.

Implementations

impl ReflectPtr

pub unsafe fn const_ref<'a>(self) -> &'a dyn Reflect

dereference the pointer as an immutable reference. The caller must ensure the pointer is valid.

Safety

pointer must point to valid non-dangling data, aliasing rules must be upheld

pub unsafe fn mut_ref<'a>(self) -> Option<&'a mut dyn Reflect>

Dereference the pointer as a mutable reference,

The caller must ensure the pointer is valid. Returns None if the underlying pointer is const

Safety

pointer must point to valid non-dangling data, aliasing rules must be upheld

pub unsafe fn map( self, get: fn(_: &dyn Reflect) -> &dyn Reflect, get_mut: fn(_: &mut dyn Reflect) -> &mut dyn Reflect ) -> Self

Maps this pointer to another one with one of two funtions depending on if mutable access is available

Safety

pointer must point to valid non-dangling data, aliasing rules must be upheld

Trait Implementations

impl Clone for ReflectPtr

fn clone(&self) -> ReflectPtr

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReflectPtr

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

Formats the value using the given formatter.

impl From<*const dyn Reflect + 'static> for ReflectPtr

fn from(ptr: *const dyn Reflect) -> Self

Converts to this type from the input type.

impl From<*mut dyn Reflect + 'static> for ReflectPtr

fn from(ptr: *mut dyn Reflect) -> Self

Converts to this type from the input type.

impl Copy for ReflectPtr

impl Send for ReflectPtr

safe since Reflect values have to be Send

impl Sync for ReflectPtr

safe since Reflect values have to be Sync