Struct DynamicMap

pub struct DynamicMap { /* private fields */ }

An ordered mapping between reflected values.

Implementations

impl DynamicMap

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

Sets the type to be represented by this DynamicMap.

Panics

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

pub fn insert<K: PartialReflect, V: PartialReflect>(&mut self, key: K, value: V)

Inserts a typed key-value pair into the map.

Trait Implementations

impl Debug for DynamicMap

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

Formats the value using the given formatter.

impl Default for DynamicMap

fn default() -> DynamicMap

Returns the “default value” for a type.

impl FromIterator<(Box<dyn PartialReflect>, Box<dyn PartialReflect>)> for DynamicMap

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

Creates a value from an iterator.

impl<K: Reflect, V: Reflect> FromIterator<(K, V)> for DynamicMap

fn from_iter<I: IntoIterator<Item = (K, V)>>(items: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a DynamicMap

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

The type of the elements being iterated over.

type IntoIter = MapIter<'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 DynamicMap

type Item = (Box<dyn PartialReflect>, Box<dyn PartialReflect>)

The type of the elements being iterated over.

type IntoIter = IntoIter<<DynamicMap 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 Map for DynamicMap

fn get(&self, key: &dyn PartialReflect) -> Option<&dyn PartialReflect>

Returns a reference to the value associated with the given key.

fn get_mut( &mut self, key: &dyn PartialReflect, ) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value associated with the given key.

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

Returns the key-value pair at index by reference, or None if out of bounds.

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

Returns the key-value pair at index by reference where the value is a mutable reference, or None if out of bounds.

fn len(&self) -> usize

Returns the number of elements in the map.

fn iter(&self) -> MapIter<'_>

Returns an iterator over the key-value pairs of the map.

fn drain(&mut self) -> Vec<(Box<dyn PartialReflect>, Box<dyn PartialReflect>)>

Drain the key-value pairs of this map to get a vector of owned values.

fn clone_dynamic(&self) -> DynamicMap

Clones the map, producing a DynamicMap.

fn insert_boxed( &mut self, key: Box<dyn PartialReflect>, value: Box<dyn PartialReflect>, ) -> Option<Box<dyn PartialReflect>>

Inserts a key-value pair into the map.

fn remove( &mut self, key: &dyn PartialReflect, ) -> Option<Box<dyn PartialReflect>>

Removes an entry from the map.

fn is_empty(&self) -> bool

Returns true if the list contains no elements.

fn get_represented_map_info(&self) -> Option<&'static MapInfo>

Will return None if TypeInfo is not available.

impl PartialReflect for DynamicMap

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 apply(&mut self, value: &dyn PartialReflect)

Applies a reflected value to this 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 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 TypePath for DynamicMap

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