Enum VariantInfo

pub enum VariantInfo {
    Struct(StructVariantInfo),
    Tuple(TupleVariantInfo),
    Unit(UnitVariantInfo),
}

A container for compile-time enum variant info.

Variants

Struct(StructVariantInfo)

Struct enums take the form:

enum MyEnum {
  A {
    foo: usize
  }
}

Tuple(TupleVariantInfo)

Tuple enums take the form:

enum MyEnum {
  A(usize)
}

Unit(UnitVariantInfo)

Unit enums take the form:

enum MyEnum {
  A
}

Implementations

impl VariantInfo

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

pub fn variant_type(&self) -> VariantType

Returns the type of this variant.

pub fn custom_attributes(&self) -> &CustomAttributes

Returns the custom attributes for this variant.

pub fn get_attribute<T: Reflect>(&self) -> Option<&T>

Gets a custom attribute by type.

For dynamically accessing an attribute, see get_attribute_by_id.

pub fn get_attribute_by_id(&self, id: TypeId) -> Option<&dyn Reflect>

Gets a custom attribute by its TypeId.

This is the dynamic equivalent of get_attribute.

pub fn has_attribute<T: Reflect>(&self) -> bool

Returns true if this variant has a custom attribute of the specified type.

For dynamically checking if an attribute exists, see has_attribute_by_id.

pub fn has_attribute_by_id(&self, id: TypeId) -> bool

Returns true if this variant has a custom attribute with the specified TypeId.

This is the dynamic equivalent of has_attribute

impl VariantInfo

Conversion convenience methods for VariantInfo.

pub fn as_struct_variant(&self) -> Result<&StructVariantInfo, VariantInfoError>

Attempts a cast to StructVariantInfo.

Returns an error if self is not VariantInfo::Struct.

pub fn as_tuple_variant(&self) -> Result<&TupleVariantInfo, VariantInfoError>

Attempts a cast to TupleVariantInfo.

Returns an error if self is not VariantInfo::Tuple.

pub fn as_unit_variant(&self) -> Result<&UnitVariantInfo, VariantInfoError>

Attempts a cast to UnitVariantInfo.

Returns an error if self is not VariantInfo::Unit.

Trait Implementations

impl Clone for VariantInfo

fn clone(&self) -> VariantInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariantInfo

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

Formats the value using the given formatter.