Struct red4ext_rs::types::Ref

pub struct Ref<T: ScriptClass>(/* private fields */);

A reference counted shared pointer to a script class.

Implementations

impl<T: ScriptClass> Ref<T>

pub fn new() -> Option<Self>

Creates a new reference to the class.

pub fn new_with(init: impl FnOnce(&mut T)) -> Option<Self>

Creates a new reference to the class and initializes it with the provided function.

pub unsafe fn fields(&self) -> Option<&T>

Returns a reference to the fields of the class.

Safety

The underlying value can be accessed mutably at any point through another copy of the Ref. Ideally, the caller should ensure that the returned reference is short-lived.

pub unsafe fn fields_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the fields of the class.

Safety

The underlying value can be accessed mutably at any point through another copy of the Ref. Ideally, the caller should ensure that the returned reference is short-lived.

pub unsafe fn instance( &self, ) -> Option<&<<T as ScriptClass>::Kind as ClassKind<T>>::NativeType>

Returns a reference to the instance of the class.

Safety

The underlying value can be accessed mutably at any point through another copy of the Ref. Ideally, the caller should ensure that the returned reference is short-lived.

pub fn downgrade(self) -> WeakRef<T>

Converts the reference to a WeakRef. This will decrement the strong reference count and increment the weak reference count.

pub fn cast<U>(self) -> Option<Ref<U>>

where U: ScriptClass,

Attempts to cast the reference to a reference of another class. Returns None if the target class is not compatible.

pub fn is_null(&self) -> bool

Returns whether the reference is null.

pub fn is_exactly_a<U>(&self) -> bool

where U: ScriptClass,

pub fn is_a<U>(&self) -> bool

where U: ScriptClass,

Trait Implementations

impl<T: ScriptClass> Clone for Ref<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ScriptClass> Default for Ref<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ScriptClass> Drop for Ref<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<A: ScriptClass> NativeRepr for Ref<A>

const NAME: &'static str = _

impl<T: ScriptClass> AsReceiver for &Ref<T>

where <T::Kind as ClassKind<T>>::NativeType: AsRef<IScriptable>,

impl<T: ScriptClass> AsReceiver for Ref<T>

where <T::Kind as ClassKind<T>>::NativeType: AsRef<IScriptable>,

impl<T: ScriptClass> Send for Ref<T>

impl<T: ScriptClass> Sync for Ref<T>