Struct bevy::reflect::EnumInfo

pub struct EnumInfo { /* private fields */ }

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

Implementations

impl EnumInfo

pub fn new<TEnum>(name: &'static str, variants: &[VariantInfo]) -> EnumInfowhere
    TEnum: Enum,

Create a new EnumInfo.

Arguments

• name: The name of this enum (without generics or lifetimes)
• variants: The variants of this enum in the order they are defined

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 name(&self) -> &'static str

The name of the enum.

This does not include any generics or lifetimes.

For example, foo::bar::Baz<'a, T> would simply be Baz.

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

The type name of the enum.

pub fn type_id(&self) -> TypeId

The TypeId of the enum.

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

Check if the given type matches the enum 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<(), Error>

Formats the value using the given formatter.