Struct DynamicStruct

pub struct DynamicStruct { /* private fields */ }

A struct type which allows fields to be added at runtime.

Implementations

impl DynamicStruct

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

Sets the type to be represented by this DynamicStruct.

Panics

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

pub fn insert_boxed<'a>( &mut self, name: impl Into<Cow<'a, str>>, value: Box<dyn PartialReflect>, )

Inserts a field named name with value value into the struct.

If the field already exists, it is overwritten.

pub fn insert<'a, T: PartialReflect>( &mut self, name: impl Into<Cow<'a, str>>, value: T, )

Inserts a field named name with the typed value value into the struct.

If the field already exists, it is overwritten.

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

Gets the index of the field with the given name.

Trait Implementations

impl Debug for DynamicStruct

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

Formats the value using the given formatter.

impl Default for DynamicStruct

fn default() -> DynamicStruct

Returns the “default value” for a type.

impl From<DynamicStruct> for DynamicVariant

fn from(value: DynamicStruct) -> Self

Converts to this type from the input type.

impl<'a, N> FromIterator<(N, Box<dyn PartialReflect>)> for DynamicStruct

where N: Into<Cow<'a, str>>,

fn from_iter<I: IntoIterator<Item = (N, Box<dyn PartialReflect>)>>( fields: I, ) -> Self

Create a dynamic struct that doesn’t represent a type from the field name, field value pairs.

impl<'a> IntoIterator for &'a DynamicStruct

type Item = &'a (dyn PartialReflect + 'static)

The type of the elements being iterated over.

type IntoIter = FieldIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for DynamicStruct

type Item = Box<dyn PartialReflect>

The type of the elements being iterated over.

type IntoIter = IntoIter<<DynamicStruct as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialReflect for DynamicStruct

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 clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

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 reflect_hash(&self) -> Option<u64>

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

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

Returns a serializable version of the value.

impl Struct for DynamicStruct

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for DynamicStruct

where DynamicStruct: 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.