gdnative_core::object

Struct TInstance

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

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§

Source§

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

Source

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

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

Source

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

Returns a reference to the script wrapper.

Source

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

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

Source§

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

Source

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.

Source§

impl<'a, T: NativeClass, Own: Ownership> TInstance<'a, T, Own>
where T::Base: GodotObject,

Methods for instances with reference-counted base classes.

Source

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.

Source

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.

Source

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§

Source§

impl<'a, T, Own: Ownership> Clone for TInstance<'a, T, Own>
where T: NativeClass,

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, T: Debug + NativeClass, Own: Debug + Ownership> Debug for TInstance<'a, T, Own>
where T::Base: Debug, T::UserData: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Auto Trait Implementations§

§

impl<'a, T, Own> Freeze for TInstance<'a, T, Own>
where <T as NativeClass>::UserData: Freeze,

§

impl<'a, T, Own> RefUnwindSafe for TInstance<'a, T, Own>
where <T as NativeClass>::UserData: RefUnwindSafe, <T as NativeClass>::Base: RefUnwindSafe, Own: RefUnwindSafe,

§

impl<'a, T, Own> Send for TInstance<'a, T, Own>
where <T as NativeClass>::UserData: Send, <T as NativeClass>::Base: Sync, Own: Send,

§

impl<'a, T, Own> Sync for TInstance<'a, T, Own>
where <T as NativeClass>::UserData: Sync, <T as NativeClass>::Base: Sync, Own: Sync,

§

impl<'a, T, Own> Unpin for TInstance<'a, T, Own>
where <T as NativeClass>::UserData: Unpin, Own: Unpin,

§

impl<'a, T, Own> UnwindSafe for TInstance<'a, T, Own>
where <T as NativeClass>::UserData: UnwindSafe, <T as NativeClass>::Base: RefUnwindSafe, Own: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.