Struct EnumInfo

pub struct EnumInfo { /* private fields */ }

A container for compile-time enum info, used by TypeInfo.

Implementations

impl EnumInfo

pub fn new<TEnum: Enum + TypePath>(variants: &[VariantInfo]) -> Self

Create a new EnumInfo.

Arguments

• variants: The variants of this enum in the order they are defined

pub fn with_custom_attributes(self, custom_attributes: CustomAttributes) -> Self

Sets the custom attributes for this enum.

pub fn variant_names(&self) -> &[&'static str]

A slice containing the names of all variants in order.

pub fn variant(&self, name: &str) -> Option<&VariantInfo>

Get a variant with the given name.

pub fn variant_at(&self, index: usize) -> Option<&VariantInfo>

Get a variant at the given index.

pub fn index_of(&self, name: &str) -> Option<usize>

Get the index of the variant with the given name.

pub fn variant_path(&self, name: &str) -> String

Returns the full path to the given variant.

This does not check if the given variant exists.

pub fn contains_variant(&self, name: &str) -> bool

Checks if a variant with the given name exists within this enum.

pub fn iter(&self) -> Iter<'_, VariantInfo>

Iterate over the variants of this enum.

pub fn variant_len(&self) -> usize

The number of variants in this enum.

pub fn ty(&self) -> &Type

The underlying Rust type.

pub fn type_id(&self) -> TypeId

The TypeId of this type.

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

The stable, full type path of this type.

Use type_path_table if you need access to the other methods on TypePath.

pub fn type_path_table(&self) -> &TypePathTable

A representation of the type path of this type.

Provides dynamic access to all methods on TypePath.

pub fn is<T: Any>(&self) -> bool

Check if the given type matches this one.

This only compares the TypeId of the types and does not verify they share the same TypePath (though it implies they do).

pub fn custom_attributes(&self) -> &CustomAttributes

Returns the custom attributes for this item.

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 item 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 item has a custom attribute with the specified TypeId.

This is the dynamic equivalent of has_attribute

pub fn generics(&self) -> &Generics

Gets the generic parameters for this type.

pub fn with_generics(self, generics: Generics) -> Self

Sets the generic parameters for this type.

Trait Implementations

impl Clone for EnumInfo

fn clone(&self) -> EnumInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnumInfo

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

Formats the value using the given formatter.