Struct gdnative_core::object::TInstance

pub struct TInstance<'a, T: NativeClass, Own: Ownership = Shared> { /* 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: NativeClass, Own: Ownership> TInstance<'a, T, Own>

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

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, Own>) -> Option<Self>

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

impl<'a, T: NativeClass, Own: NonUniqueOwnership> TInstance<'a, T, Own>

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: NativeClass, Own: Ownership> TInstance<'a, T, Own>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, 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::UserData as MapMut>::Err>where
    T::UserData: MapMut,
    F: FnOnce(&mut T, TRef<'_, T::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::UserData as MapOwned>::Err>where
    T::UserData: MapOwned,
    F: FnOnce(T, TRef<'_, T::Base, Own>) -> U,

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

Trait Implementations

impl<'a, T, Own: Ownership> Clone for TInstance<'a, T, Own>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, Own: Debug + Ownership> Debug for TInstance<'a, T, Own>where
    T::Base: Debug,
    T::UserData: Debug,

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

Formats the value using the given formatter.

impl<'a, T, U> AsArg<U> for TInstance<'a, T, Shared>where
    T: NativeClass,
    T::Base: GodotObject + SubClass<U>,
    T::UserData: Map,
    U: GodotObject,