Struct RefArg

pub struct RefArg<'r, T> { /* private fields */ }

Simple reference wrapper, used when passing arguments by-ref to Godot APIs.

This type is often used as the result of ToGodot::to_godot(), if Self is not a Copy type.

Implementations

impl<'r, T> RefArg<'r, T>

pub fn new(shared_ref: &'r T) -> RefArg<'r, T>

Creates a new RefArg from a reference.

Unless you implement your own ToGodot impl, there is usually no reason to use this.

pub fn get_ref(&self) -> &T

Returns the stored reference.

Panics

If T is Option<Gd<...>>::None.

pub fn get_ref_or_none(&self) -> Option<&T>

where T: GodotNullableFfi,

Returns the stored reference.

Returns None if T is Option<Gd<...>>::None.

pub fn to_owned(&self) -> T

where T: Clone,

Returns the stored reference.

Panics

If T is Option<Gd<...>>::None.

Trait Implementations

impl<'r, T> Debug for RefArg<'r, T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'r, T> FromGodot for RefArg<'r, T>

where T: FromGodot,

fn try_from_godot( _via: <RefArg<'r, T> as GodotConvert>::Via, ) -> Result<RefArg<'r, T>, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant.

impl<'r, T> GodotConvert for RefArg<'r, T>

where T: GodotConvert,

type Via = <T as GodotConvert>::Via

The type through which Self is represented in Godot.

impl<'r, T> GodotNullableFfi for RefArg<'r, T>

where T: GodotNullableFfi,

fn null() -> RefArg<'r, T>

fn is_null(&self) -> bool

fn flatten_option(opt: Option<Self>) -> Self

impl<'r, T> ToGodot for RefArg<'r, T>

where T: ToGodot,

type ToVia<'v> = <T as ToGodot>::ToVia<'v> where RefArg<'r, T>: 'v

Target type of to_godot(), which can differ from Via for pass-by-reference types.

fn to_godot(&self) -> <RefArg<'r, T> as ToGodot>::ToVia<'_>

Converts this type to the Godot type by reference, usually by cloning.

fn to_variant(&self) -> Variant

Converts this type to a Variant.