ElementType

Enum ElementType 

pub enum ElementType {
    Untyped,
    Builtin(VariantType),
    Class(ClassId),
    ScriptClass(ElementScript),
}
Expand description

Dynamic type information of Godot arrays and dictionaries.

Used by Array::element_type(), dictionary key/value type methods, and other type introspection functionality.

While Rust’s type parameters provide compile-time type information, this method can give additional RTTI (runtime type information). For example, Array<Gd<RefCounted>> may store classes or scripts derived from RefCounted.

Variants§

§

Untyped

Untyped array/dictionary that can contain any Variant.

§

Builtin(VariantType)

Typed array with built-in type (e.g., Array<i64>, Array<GString>).

§

Class(ClassId)

Typed array with class (e.g., Array<Gd<Node3D>>, Array<Gd<Resource>>).

§

ScriptClass(ElementScript)

Typed array with a script-based class (e.g. GDScript class Enemy).

Arrays of this element type cannot be created directly in Rust code. They come into play when you have a GDScript with class_name MyClass, and then create a typed Array[MyClass] in GDScript. In Rust, these arrays can be represented with their native base class (the one mentioned in extends in GDScript), e.g. Array<Gd<RefCounted>>.

Implementations§

§

impl ElementType

pub fn of<T>() -> ElementType
where T: ArrayElement,

Build element type info for a compile-time element T.

pub fn is_typed(&self) -> bool

True if this denotes a typed array (non-NIL variant type).

pub fn variant_type(&self) -> VariantType

The VariantType corresponding to this element type.

pub fn class_id(&self) -> Option<ClassId>

The class ID, if this type is of type Class or ScriptClass.

Trait Implementations§

§

impl Clone for ElementType

§

fn clone(&self) -> ElementType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ElementType

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for ElementType

§

fn eq(&self, other: &ElementType) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl Copy for ElementType

§

impl Eq for ElementType

§

impl StructuralPartialEq for ElementType

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.