Struct gdnative_core::nativescript::class::RefInstance

pub struct RefInstance<'a, T: NativeClass, Access: ThreadAccess> { /* fields omitted */ }

A reference to a GodotObject with a rust NativeClass attached that is assumed safe during a certain lifetime.

See the type-level documentation on Ref for more information on typed thread accesses.

Implementations

impl<'a, T: NativeClass, Access: ThreadAccess> RefInstance<'a, T, Access>

pub fn base(&self) -> TRef<'a, T::Base, Access>

Returns a reference to the base object with the same lifetime.

pub fn script(&self) -> &T::UserData

Returns a reference to the script wrapper.

pub fn try_from_base(owner: TRef<'a, T::Base, Access>) -> Option<Self>

Try to downcast TRef<'a, T::Base, Access> to RefInstance<T>.

impl<'a, T: NativeClass, Access: ThreadAccess> RefInstance<'a, T, Access> where
    T::Base: GodotObject, 

Methods for instances with reference-counted base classes.

pub fn map<F, U>(&self, op: F) -> Result<U, <T::UserData as Map>::Err> where
    T::UserData: Map,
    F: FnOnce(&T, TRef<T::Base, Access>) -> U, 

Calls a function with a NativeClass instance and its owner, and returns its return value.

pub fn map_mut<F, U>(&self, op: F) -> Result<U, <T::UserData as MapMut>::Err> where
    T::UserData: MapMut,
    F: FnOnce(&mut T, TRef<T::Base, Access>) -> U, 

Calls a function with a NativeClass instance and its owner, and returns its return value.

Trait Implementations

impl<'a, T, Access: ThreadAccess> Clone for RefInstance<'a, T, Access> where
    T: NativeClass, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + NativeClass, Access: Debug + ThreadAccess> Debug for RefInstance<'a, T, Access> where
    T::Base: Debug,
    T::UserData: Debug, 

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

Formats the value using the given formatter.