Struct gdnative::Instance

pub struct Instance<T> where
    T: NativeClass,  { /* fields omitted */ }

A reference to a GodotObject with a rust NativeClass attached.

Methods

impl<T> Instance<T> where
    T: NativeClass, 

pub fn new() -> Instance<T> where
    <T as NativeClass>::Base: Instanciable, 

Creates a T::Base with the script T attached. Both T::Base and T must have zero argument constructors.

Must be called after the library is initialized.

pub fn into_base(self) -> <T as NativeClass>::Base

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

pub fn decouple(
    self
) -> (<T as NativeClass>::Base, <T as NativeClass>::UserData)

pub fn base(&self) -> &<T as NativeClass>::Base

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

pub fn try_from_base(owner: <T as NativeClass>::Base) -> Option<Instance<T>> where
    <T as NativeClass>::Base: Clone, 

Try to downcast T::Base to Instance<T>. This safe version can only be used with reference counted base classes.

pub unsafe fn try_from_unsafe_base(
    owner: <T as NativeClass>::Base
) -> Option<Instance<T>>

Try to downcast T::Base to Instance<T>.

Safety

It's up to the caller to ensure that owner points to a valid Godot object, and that it will not be freed until this function returns. Otherwise, it is undefined behavior to call this function and/or use its return value.

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

Calls a function with a NativeClass instance and its owner, and returns its return value. Can be used on reference counted types for multiple times.

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

Calls a function with a NativeClass instance and its owner, and returns its return value. Can be used on reference counted types for multiple times.

pub unsafe fn map_aliased<F, U>(
    &self,
    op: F
) -> Result<U, <<T as NativeClass>::UserData as Map>::Err> where
    F: FnOnce(&T, <T as NativeClass>::Base) -> U,
    <T as NativeClass>::UserData: Map, 

Calls a function with a NativeClass instance and its owner, and returns its return value. Can be used for multiple times via aliasing:

unsafe {
    instance.map_aliased(/* ... */);
    // instance.owner may be invalid now, but you can still:
    instance.map_aliased(/* ... */);
    instance.map_aliased(/* ... */); // ...for multiple times
}

For reference-counted types behaves like the safe map, which should be preferred.

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

Calls a function with a NativeClass instance and its owner, and returns its return value. Can be used for multiple times via aliasing:

unsafe {
    instance.map_mut_aliased(/* ... */);
    // instance.owner may be invalid now, but you can still:
    instance.map_mut_aliased(/* ... */);
    instance.map_mut_aliased(/* ... */); // ...for multiple times
}

For reference-counted types behaves like the safe map_mut, which should be preferred.

Trait Implementations

impl<T> Clone for Instance<T> where
    T: NativeClass,
    <T as NativeClass>::Base: Clone, 

fn clone(&self) -> Instance<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Instance<T> where
    T: NativeClass + Debug,
    <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<T> Eq for Instance<T> where
    T: NativeClass + Eq,
    <T as NativeClass>::Base: Eq,
    <T as NativeClass>::UserData: Eq, 

impl<T> Export for Instance<T> where
    T: NativeClass,
    <T as NativeClass>::Base: ToVariant, 

type Hint = ()

A type-specific hint type that is valid for the type being exported.

fn export_info(_hint: Option<<Instance<T> as Export>::Hint>) -> ExportInfo

Returns ExportInfo given an optional typed hint.

impl<T> FromVariant for Instance<T> where
    T: NativeClass,
    <T as NativeClass>::Base: FromVariant,
    <T as NativeClass>::Base: Clone, 

fn from_variant(variant: &Variant) -> Result<Instance<T>, FromVariantError>

impl<T> Ord for Instance<T> where
    T: NativeClass + Ord,
    <T as NativeClass>::Base: Ord,
    <T as NativeClass>::UserData: Ord, 

fn cmp(&self, other: &Instance<T>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T> PartialEq<Instance<T>> for Instance<T> where
    T: NativeClass + PartialEq<T>,
    <T as NativeClass>::Base: PartialEq<<T as NativeClass>::Base>,
    <T as NativeClass>::UserData: PartialEq<<T as NativeClass>::UserData>, 

fn eq(&self, other: &Instance<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Instance<T>) -> bool

This method tests for !=.

impl<T> PartialOrd<Instance<T>> for Instance<T> where
    T: NativeClass + PartialOrd<T>,
    <T as NativeClass>::Base: PartialOrd<<T as NativeClass>::Base>,
    <T as NativeClass>::UserData: PartialOrd<<T as NativeClass>::UserData>, 

fn partial_cmp(&self, other: &Instance<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Instance<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Instance<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Instance<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Instance<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> StructuralEq for Instance<T> where
    T: NativeClass, 

impl<T> StructuralPartialEq for Instance<T> where
    T: NativeClass, 

impl<T> ToVariant for Instance<T> where
    T: NativeClass,
    <T as NativeClass>::Base: ToVariant, 

fn to_variant(&self) -> Variant