Struct TInstance 

pub struct TInstance<'a, T, Own = Shared>
where
    T: NativeClass,
    Own: Ownership,
{ /* private fields */ }

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, Own> TInstance<'a, T, Own>

where T: NativeClass, Own: Ownership,

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

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

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

Returns a reference to the script wrapper.

pub fn try_from_base( owner: TRef<'a, <T as NativeClass>::Base, Own>, ) -> Option<TInstance<'a, T, Own>>

Try to downcast TRef<'a, T::Base, Own> to TInstance<T>.

impl<'a, T, Own> TInstance<'a, T, Own>

where T: NativeClass, Own: NonUniqueOwnership,

pub fn claim(self) -> Instance<T, Own>

Persists this into a persistent Instance with the same thread access, without cloning the userdata wrapper.

This is only available for non-Unique accesses.

impl<'a, T, Own> TInstance<'a, T, Own>

where T: NativeClass, Own: Ownership, <T as NativeClass>::Base: GodotObject,

Methods for instances with reference-counted base classes.

pub fn map<F, U>( &self, op: F, ) -> Result<U, <<T as NativeClass>::UserData as Map>::Err>

where <T as NativeClass>::UserData: Map, F: FnOnce(&T, TRef<'_, <T as NativeClass>::Base, Own>) -> 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 as NativeClass>::UserData as MapMut>::Err>

where <T as NativeClass>::UserData: MapMut, F: FnOnce(&mut T, TRef<'_, <T as NativeClass>::Base, Own>) -> U,

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

pub fn map_owned<F, U>( &self, op: F, ) -> Result<U, <<T as NativeClass>::UserData as MapOwned>::Err>

where <T as NativeClass>::UserData: MapOwned, F: FnOnce(T, TRef<'_, <T as NativeClass>::Base, Own>) -> U,

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

Trait Implementations

impl<'a, T, Own> Clone for TInstance<'a, T, Own>

where Own: Ownership, T: NativeClass,

fn clone(&self) -> TInstance<'a, T, Own>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T, Own> Debug for TInstance<'a, T, Own>

where T: Debug + NativeClass, Own: Debug + Ownership, <T as NativeClass>::Base: Debug, <T as NativeClass>::UserData: Debug,

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

Formats the value using the given formatter.

impl<'a, T, U> AsArg<U> for TInstance<'a, T>

where T: NativeClass, <T as NativeClass>::Base: GodotObject + SubClass<U>, <T as NativeClass>::UserData: Map, U: GodotObject,