Trait FromReflect

Source

pub trait FromReflect: Reflect + Sized {
    // Required method
    fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>;

    // Provided method
    fn take_from_reflect(
        reflect: Box<dyn PartialReflect>,
    ) -> Result<Self, Box<dyn PartialReflect>> { ... }
}

Expand description

A trait that enables types to be dynamically constructed from reflected data.

It’s recommended to use the derive macro rather than manually implementing this trait.

FromReflect allows dynamic proxy types, like DynamicStruct, to be used to generate their concrete counterparts. It can also be used to partially or fully clone a type (depending on whether it has ignored fields or not).

In some cases, this trait may even be required. Deriving Reflect on an enum requires all its fields to implement FromReflect. Additionally, some complex types like Vec<T> require that their element types implement this trait. The reason for such requirements is that some operations require new data to be constructed, such as swapping to a new variant or pushing data to a homogeneous list.

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

Required Methods§

Source

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

Provided Methods§

Source

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

This method is more efficient than using from_reflect for cases where the given value is likely a boxed instance of Self (i.e. Box<Self>) rather than a boxed dynamic type (e.g. DynamicStruct, DynamicList, etc.).

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait FromReflect Copy item path

Required Methods§

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Provided Methods§

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Dyn Compatibility§

Implementations on Foreign Types§

impl FromReflect for &'static str

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for &'static Location<'static>

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for &'static Path

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for Cow<'static, str>

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for Cow<'static, Path>

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for SocketAddr

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for EulerRot

fn from_reflect(__param0: &dyn PartialReflect) -> Option<Self>

impl FromReflect for TextureFormat

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for bool

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for char

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for f32

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for f64

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for i8

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for i16

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for i32

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for i64

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for i128

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for isize

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for u8

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for u16

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for u32

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for u64

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for u128

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for ()

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for usize

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for String

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for TypeId

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for RangeFull

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicBool

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicI8

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicI16

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicI32

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicI64

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicIsize

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicU8

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicU16

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

impl FromReflect for AtomicU32

Trait FromReflect