Struct ComponentHint 

pub struct ComponentHint {
    pub name: &'static RustIdent,
    pub ty: TypeHint,
    pub doc: Option<&'static str>,
}

A description of a statically known field of the type: object.field.

The field could be an object of a particular type or an object’s method available for invocation.

Fields

name: &'static RustIdent

The name of the field.

ty: TypeHint

The type of the field.

In the case of methods, the TypeHint is usually TypeHint::Invocation, which describes the invocation signature of the method.

doc: Option<&'static str>

The relevant RustDoc documentation for the field.

This documentation pertains to the field itself and is (usually) different from the documentation found in the TypeHint::doc of the field’s type description.

use ad_astra::export;

#[export]
struct Foo {
    /// A ComponentHint's documentation.
    pub field: usize,
}

#[export]
impl Foo {
    /// A ComponentHint's documentation.
    pub fn method(&self) {}
}

Trait Implementations

impl Clone for ComponentHint

fn clone(&self) -> ComponentHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ComponentHint

impl Debug for ComponentHint

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

Formats the value using the given formatter.

impl Display for ComponentHint

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

Formats the value using the given formatter.

impl Eq for ComponentHint

impl Ord for ComponentHint

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 for ComponentHint

fn eq(&self, other: &ComponentHint) -> 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 ComponentHint

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 StructuralPartialEq for ComponentHint