Struct M 

pub struct M<'w, T>(pub &'w mut T);

A wrapper around a mutable reference to a value of type T.

This can be used to retrieve a mutable reference out of a ScriptValue::Reference corresponding to the type T. Before downcasting the reference, it will claim write access to the object to ensure that the reference is valid.

However, the access is NOT released when the Mut is dropped. This is not unsafe but can lead to deadlocks if not released later. The [ScriptFunction] calling mechanism will take care of releasing all accesses claimed during the function call.

Tuple Fields

0: &'w mut T

Trait Implementations

impl<T> ArgMeta for M<'_, T>

fn default_value() -> Option<ScriptValue>

The default value for the argument. Used when the argument is not provided.

fn variadic() -> bool

If returns true, will absorb all arguments following itself

impl<T> Deref for M<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for M<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T> From<&'a mut T> for M<'a, T>

fn from(value: &'a mut T) -> Self

Converts to this type from the input type.

impl<T: FromReflect> FromScript for M<'_, T>

type This<'w> = M<'w, T>

The type that is constructed from the script value.

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self::This<'_>, InteropError>

Construct a value of type T from a ScriptValue.

impl<'a, T> GetTypeDependencies for M<'a, T>

where T: GetTypeRegistration,

type Underlying = T

In the majority of the implementations, this will be Self However some types might be facades for other types, in which case this will be the underlying type

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers the type dependencies of the implementing type with the given TypeRegistry.

impl<T: Typed> TypedThrough for M<'_, T>

fn through_type_info() -> ThroughTypeInfo

Get the ThroughTypeInfo for the type.