Struct gdnative::api::Expression

pub struct Expression { /* fields omitted */ }

core class Expression 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

Expression inherits methods from:

• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl Expression

pub fn new() -> Ref<Expression, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn execute(
    &self,
    inputs: VariantArray<Shared>,
    base_instance: impl AsArg<Object>,
    show_error: bool
) -> Variant

Executes the expression that was previously parsed by [method parse] and returns the result. Before you use the returned object, you should check if the method failed by calling [method has_execute_failed].
				If you defined input variables in [method parse], you can specify their values in the inputs array, in the same order.

Default Arguments

• inputs - [ ]
• base_instance - null
• show_error - true

pub fn get_error_text(&self) -> GodotString

Returns the error text if [method parse] has failed.

pub fn has_execute_failed(&self) -> bool

Returns [code]true[/code] if [method execute] has failed.

pub fn parse(
    &self,
    expression: impl Into<GodotString>,
    input_names: TypedArray<GodotString>
) -> Result<(), GodotError>

Parses the expression and returns an [enum Error] code.
				You can optionally specify names of variables that may appear in the expression with [code]input_names[/code], so that you can bind them when it gets executed.

Default Arguments

• input_names - PoolStringArray( )

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for Expression

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

Formats the value using the given formatter.

impl Deref for Expression

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for Expression

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

Mutably dereferences the value.

impl GodotObject for Expression

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for Expression

fn construct() -> Ref<Expression, Unique>

impl SubClass<Object> for Expression

impl SubClass<Reference> for Expression