Struct 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(
  "None",
  DynamicVariant::Unit
);

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

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

Implementations

impl DynamicEnum

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

Create a new DynamicEnum to represent an enum at runtime.

Arguments

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

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

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

Arguments

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

pub fn set_represented_type( &mut self, represented_type: Option<&'static TypeInfo>, )

Sets the type to be represented by this DynamicEnum.

Panics

Panics if the given type is not a TypeInfo::Enum.

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

Set the current enum variant represented by this struct.

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

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

pub fn variant(&self) -> &DynamicVariant

Get a reference to the DynamicVariant contained in self.

pub fn variant_mut(&mut self) -> &mut DynamicVariant

Get a mutable reference to the DynamicVariant contained in self.

Using the mut reference to switch to a different variant will not update the internal tracking of the variant name and index.

If you want to switch variants, prefer one of the setters: DynamicEnum::set_variant or DynamicEnum::set_variant_with_index.

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

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: Enum + ?Sized>(value: &TEnum) -> Self

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

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 PartialReflect>

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 PartialReflect>

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 PartialReflect>

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 PartialReflect>

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

👎Deprecated since 0.16.0: use to_dynamic_enum instead

fn to_dynamic_enum(&self) -> DynamicEnum

Creates a new DynamicEnum from this enum.

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.

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

Will return None if TypeInfo is not available.

impl PartialReflect for DynamicEnum

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

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

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

fn apply(&mut self, value: &dyn PartialReflect)

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

impl TypePath for DynamicEnum

where DynamicEnum: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.