Struct gdnative_core::object::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 copy of the value. Read more

1.0.0 · source

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 for TInstance<'a, T, Shared> where
 T: NativeClass,
 T::Base: GodotObject + SubClass,
 T::UserData: Map,
 U: GodotObject,

Auto Trait Implementations

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

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

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

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

impl<'a, T, Own> UnwindSafe for TInstance<'a, T, Own> where
 Own: UnwindSafe,
 <T as NativeClass>::Base: RefUnwindSafe,
 <T as NativeClass>::UserData: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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,

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct gdnative_core::object::TInstance

Implementations

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

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

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

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

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

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

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

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,

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,

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,

Trait Implementations

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

fn clone(&self) -> Self

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

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

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> RefUnwindSafe for TInstance<'a, T, Own> where Own: RefUnwindSafe, <T as NativeClass>::Base: RefUnwindSafe, <T as NativeClass>::UserData: RefUnwindSafe,

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

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

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

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

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,

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,

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,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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