Struct gdnative::WeakRef

pub struct WeakRef { /* fields omitted */ }

core class WeakRef inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

WeakRef inherits methods from:

• Reference
• Object

Methods

impl WeakRef

pub fn new() -> WeakRef

pub fn new_ref(&self) -> WeakRef

Creates a new reference to the same reference-counted object.

pub fn get_ref(&self) -> Variant

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Reference>

pub fn new_ref(&self) -> Reference

Creates a new reference to the same reference-counted object.

pub fn init_ref(&mut self) -> bool

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for WeakRef

fn clone(&self) -> WeakRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeakRef

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

Formats the value using the given formatter.

impl Deref for WeakRef

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for WeakRef

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl Drop for WeakRef

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for WeakRef

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

impl GodotObject for WeakRef

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> WeakRef

unsafe fn from_return_position_sys(obj: *mut c_void) -> WeakRef

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for WeakRef

fn construct() -> WeakRef

impl ToVariant for WeakRef

fn to_variant(&self) -> Variant