Struct bevy::reflect::DynamicEnum

pub struct DynamicEnum { /* private fields */ }

A dynamic representation of an enum.

This allows for enums to be configured at runtime.

Example

// The original enum value
let mut value: Option<usize> = Some(123);

// Create a DynamicEnum to represent the new value
let mut dyn_enum = DynamicEnum::new(
  Reflect::type_name(&value),
  "None",
  DynamicVariant::Unit
);

// Apply the DynamicEnum as a patch to the original value
value.apply(&dyn_enum);

// Tada!
assert_eq!(None, value);

Implementations

impl DynamicEnum

pub fn new<I, V>(name: I, variant_name: I, variant: V) -> DynamicEnumwhere
    I: Into<String>,
    V: Into<DynamicVariant>,

Create a new DynamicEnum to represent an enum at runtime.

Arguments

• name: The type name of the enum
• variant_name: The name of the variant to set
• variant: The variant data

pub fn new_with_index<I, V>(
    name: I,
    variant_index: usize,
    variant_name: I,
    variant: V
) -> DynamicEnumwhere
    I: Into<String>,
    V: Into<DynamicVariant>,

Create a new DynamicEnum with a variant index to represent an enum at runtime.

Arguments

• name: The type name of the enum
• variant_index: The index of the variant to set
• variant_name: The name of the variant to set
• variant: The variant data

pub fn name(&self) -> &str

Returns the type name of the enum.

pub fn set_name(&mut self, name: String)

Sets the type name of the enum.

pub fn set_variant<I, V>(&mut self, name: I, variant: V)where
    I: Into<String>,
    V: Into<DynamicVariant>,

Set the current enum variant represented by this struct.

pub fn set_variant_with_index<I, V>(
    &mut self,
    variant_index: usize,
    name: I,
    variant: V
)where
    I: Into<String>,
    V: Into<DynamicVariant>,

Set the current enum variant represented by this struct along with its variant index.

pub fn from<TEnum>(value: TEnum) -> DynamicEnumwhere
    TEnum: Enum,

Create a DynamicEnum from an existing one.

This is functionally the same as DynamicEnum::from_ref except it takes an owned value.

pub fn from_ref<TEnum>(value: &TEnum) -> DynamicEnumwhere
    TEnum: Enum,

Create a DynamicEnum from an existing one.

This is functionally the same as DynamicEnum::from except it takes a reference.

Trait Implementations

impl Debug for DynamicEnum

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

Formats the value using the given formatter.

impl Default for DynamicEnum

fn default() -> DynamicEnum

Returns the “default value” for a type.

impl Enum for DynamicEnum

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

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

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl Reflect for DynamicEnum

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

fn into_any(self: Box<DynamicEnum, Global>) -> Box<dyn Any + 'static, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(
    self: Box<DynamicEnum, Global>
) -> Box<dyn Reflect + 'static, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn set(
    &mut self,
    value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>

Performs a type-checked assignment of a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<DynamicEnum, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl Typed for DynamicEnum

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.