Trait bevy_reflect::Reflect

source ·

pub trait Reflect: DynamicTypePath + Any + Send + Sync {
Show 19 methods    // Required methods
    fn get_represented_type_info(&self) -> Option<&'static TypeInfo>;
    fn into_any(self: Box<Self>) -> Box<dyn Any>;
    fn as_any(&self) -> &dyn Any;
    fn as_any_mut(&mut self) -> &mut dyn Any;
    fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>;
    fn as_reflect(&self) -> &dyn Reflect;
    fn as_reflect_mut(&mut self) -> &mut dyn Reflect;
    fn apply(&mut self, value: &dyn Reflect);
    fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>;
    fn reflect_ref(&self) -> ReflectRef<'_>;
    fn reflect_mut(&mut self) -> ReflectMut<'_>;
    fn reflect_owned(self: Box<Self>) -> ReflectOwned;
    fn clone_value(&self) -> Box<dyn Reflect>;

    // Provided methods
    fn reflect_kind(&self) -> ReflectKind { ... }
    fn reflect_hash(&self) -> Option<u64> { ... }
    fn reflect_partial_eq(&self, _value: &dyn Reflect) -> Option<bool> { ... }
    fn debug(&self, f: &mut Formatter<'_>) -> Result { ... }
    fn serializable(&self) -> Option<Serializable<'_>> { ... }
    fn is_dynamic(&self) -> bool { ... }
}

Expand description

The core trait of bevy_reflect, used for accessing and modifying data dynamically.

It’s recommended to use the derive macro rather than manually implementing this trait. Doing so will automatically implement many other useful traits for reflection, including one of the appropriate subtraits: Struct, TupleStruct or Enum.

See the crate-level documentation to see how this trait and its subtraits can be used.

Required Methods§

source

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

Returns the TypeInfo of the type represented by this value.

For most types, this will simply return their own TypeInfo. However, for dynamic types, such as DynamicStruct or DynamicList, this will return the type they represent (or None if they don’t represent any particular type).

This method is great if you have an instance of a type or a dyn Reflect, and want to access its TypeInfo. However, if this method is to be called frequently, consider using TypeRegistry::get_type_info as it can be more performant for such use cases.

source

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

source

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

source

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

source

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

source

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

source

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

source

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

Applies a reflected value to this value.

If a type implements a subtrait of Reflect, then the semantics of this method are as follows:

If T is a Struct, then the value of each named field of value is applied to the corresponding named field of self. Fields which are not present in both structs are ignored.
If T is a TupleStruct or Tuple, then the value of each numbered field is applied to the corresponding numbered field of self. Fields which are not present in both values are ignored.
If T is an Enum, then the variant of self is updated to match the variant of value. The corresponding fields of that variant are applied from value onto self. Fields which are not present in both values are ignored.
If T is a List or Array, then each element of value is applied to the corresponding element of self. Up to self.len() items are applied, and excess elements in value are appended to self.
If T is a Map, then for each key in value, the associated value is applied to the value associated with the same key in self. Keys which are not present in self are inserted.
If T is none of these, then value is downcast to T, cloned, and assigned to self.

Note that Reflect must be implemented manually for Lists and Maps in order to achieve the correct semantics, as derived implementations will have the semantics for Struct, TupleStruct, Enum or none of the above depending on the kind of type. For lists and maps, use the list_apply and map_apply helper functions when implementing this method.

§Panics

Derived implementations of this method will panic:

If the type of value is not of the same kind as T (e.g. if T is a List, while value is a Struct).
If T is any complex type and the corresponding fields or elements of self and value are not of the same type.
If T is a value type and self cannot be downcast to T

source

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

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

If value does not contain a value of type T, returns an Err containing the trait object.

source

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

Returns an immutable enumeration of “kinds” of type.

See ReflectRef.

source

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

Returns a mutable enumeration of “kinds” of type.

See ReflectMut.

source

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

Returns an owned enumeration of “kinds” of type.

See ReflectOwned.

source

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

Clones the value as a Reflect trait object.

When deriving Reflect for a struct, tuple struct or enum, the value is cloned via Struct::clone_dynamic, TupleStruct::clone_dynamic, or Enum::clone_dynamic, respectively. Implementors of other Reflect subtraits (e.g. List, Map) should use those subtraits’ respective clone_dynamic methods.

Provided Methods§

source

fn reflect_kind(&self) -> ReflectKind

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

See ReflectKind.

source

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

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

If the underlying type does not support hashing, returns None.

source

fn reflect_partial_eq(&self, _value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

If the underlying type does not support equality testing, returns None.

source

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

Debug formatter for the value.

Any value that is not an implementor of other Reflect subtraits (e.g. List, Map), will default to the format: "Reflect(type_path)", where type_path is the type path of the underlying type.

source

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

Returns a serializable version of the value.

If the underlying type does not support serialization, returns None.

source

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

Dynamic types include the ones built-in to this crate, such as DynamicStruct, DynamicList, and DynamicTuple. However, they may be custom types used as proxies for other types or to facilitate scripting capabilities.

By default, this method will return false.

Trait bevy_reflect::Reflect

Required Methods§

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

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

fn as_reflect(&self) -> &dyn Reflect

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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

§Panics

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

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

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

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

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

Provided Methods§

fn reflect_kind(&self) -> ReflectKind

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

fn reflect_partial_eq(&self, _value: &dyn Reflect) -> Option<bool>

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

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

fn is_dynamic(&self) -> bool

Implementations§

impl dyn Reflect

pub fn downcast<T: Reflect>( self: Box<dyn Reflect> ) -> Result<Box<T>, Box<dyn Reflect>>

pub fn take<T: Reflect>(self: Box<dyn Reflect>) -> Result<T, Box<dyn Reflect>>

pub fn represents<T: Reflect + TypePath>(&self) -> bool

pub fn is<T: Reflect>(&self) -> bool

pub fn downcast_ref<T: Reflect>(&self) -> Option<&T>

pub fn downcast_mut<T: Reflect>(&mut self) -> Option<&mut T>

Trait Implementations§

impl Debug for dyn Reflect

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

impl TypePath for dyn Reflect

fn type_path() -> &'static str

fn short_type_path() -> &'static str

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

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

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

impl Typed for dyn Reflect

fn type_info() -> &'static TypeInfo

Implementations on Foreign Types§

impl Reflect for &'static str

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

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

fn as_reflect(&self) -> &dyn Reflect

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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

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

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

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

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

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

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

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

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

impl Reflect for &'static Path

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

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

fn as_reflect(&self) -> &dyn Reflect

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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

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

fn reflect_kind(&self) -> ReflectKind

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

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

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

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

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

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

impl Reflect for Cow<'static, str>

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

fn into_any(self: Box<Self>) -> Box<dyn Any>

impl Reflect for bool
where Self: Any + Send + Sync,

impl Reflect for char
where Self: Any + Send + Sync,