Struct TypeMeta

pub struct TypeMeta { /* private fields */ }

An introspection metadata for the Rust type registered by the Script Engine.

You cannot create this object manually; its creation is managed by the Script Engine. However, you can obtain a 'static reference to this object using the ScriptType::type_meta function and other related API functions.

The Display implementation prints the user-facing name of the type (e.g., "usize", "str", or "Vec<bool>").

This object allows you to explore the type’s introspection metadata and the Script operations available for this type using the TypeMeta::prototype function.

Implementations

impl TypeMeta

pub fn prototype(&self) -> &'static Prototype

Returns a Prototype of the Rust type that describes the script operations available for this type.

pub fn instantiate(&'static self, origin: Origin) -> RuntimeResult<Cell>

Creates an instance of this type using the default constructor.

The function returns RuntimeError if the default constructor is not exported for this type, or if the constructor’s implementation returns a RuntimeError.

pub fn concat( &'static self, origin: Origin, items: &mut [Arg], ) -> RuntimeResult<Cell>

Creates an array of objects by concatenating the data in items into a single slice in the resulting Cell.

The items source array does not necessarily have to be an array of objects of the same type. The underlying implementation may attempt to cast them into other types. The source array may also contain “gaps” (Nil Cells) and Cells with arrays. In this case, the canonical implementation of this operator typically flattens these sub-arrays. Additionally, the canonical implementation usually takes Arg objects from the items source slice.

The origin parameter specifies the Rust or Script source code range that spans the operator (e.g., the script array declaration).

The function returns a RuntimeError if the type does not support the “concat” operator, or if the operator’s implementation returns a RuntimeError.

impl TypeMeta

pub fn nil() -> &'static Self

Returns the metadata of the unit () type. In Ad Astra terminology, the unit type is referred to as the “nil type” and represents inaccessible data.

The Nil Cell corresponds to the Nil type.

This function is a shortcut for <()>::type_meta().

pub fn dynamic() -> &'static Self

Returns the metadata of the type placeholder that cannot be analyzed at script compile-time.

This function is a shortcut for <DynamicType>::type_meta().

pub fn id(&self) -> &TypeId

Returns the TypeId of the original Rust type.

pub fn is_nil(&self) -> bool

Returns true if this type is a Nil type, which represents a void, inaccessible object.

pub fn is_dynamic(&self) -> bool

Returns true if the type is a Dynamic type, a type placeholder that cannot be analyzed at script compile-time.

pub fn is_fn(&self) -> bool

Returns true if this type belongs to the family of functions.

These types typically support the invocation operator.

This function is a shortcut for type_meta_family().is_fn().

pub fn name(&self) -> &'static str

Returns the user-facing name of the original Rust type, such as "usize", "str", "Vec<bool>", etc.

pub fn origin(&self) -> &'static RustOrigin

Returns the location in the Rust source code where the Rust type was declared (or registered by the export macro).

pub fn doc(&self) -> Option<&'static str>

Returns the RustDoc documentation for the Rust type.

The function returns None if the type does not have documentation or if the documentation was not recognized by the export macro.

pub fn family(&self) -> &TypeFamily

Returns a reference to the family of types to which this Rust type belongs.

Trait Implementations

impl Clone for TypeMeta

fn clone(&self) -> TypeMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeMeta

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

Formats the value using the given formatter.

impl Default for &'static TypeMeta

fn default() -> Self

Returns the “default value” for a type.

impl Display for TypeMeta

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

Formats the value using the given formatter.

impl From<&'static TypeMeta> for TypeHint

fn from(value: &'static TypeMeta) -> Self

Converts to this type from the input type.

impl Hash for TypeMeta

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TypeMeta

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<TypeId> for TypeMeta

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq for TypeMeta

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

Tests for self and other values to be equal, and is used by ==.

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 PartialOrd for TypeMeta

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for TypeMeta

impl Eq for TypeMeta