bevy_reflect/

lib.rs

#![cfg_attr(
    any(docsrs, docsrs_dep),
    expect(
        internal_features,
        reason = "rustdoc_internals is needed for fake_variadic"
    )
)]
#![cfg_attr(any(docsrs, docsrs_dep), feature(doc_cfg, rustdoc_internals))]
#![doc(
    html_logo_url = "https://bevy.org/assets/icon.png",
    html_favicon_url = "https://bevy.org/assets/icon.png"
)]

//! Reflection in Rust.
//!
//! [Reflection] is a powerful tool provided within many programming languages
//! that allows for meta-programming: using information _about_ the program to
//! _affect_ the program.
//! In other words, reflection allows us to inspect the program itself, its
//! syntax, and its type information at runtime.
//!
//! This crate adds this missing reflection functionality to Rust.
//! Though it was made with the [Bevy] game engine in mind,
//! it's a general-purpose solution that can be used in any Rust project.
//!
//! At a very high level, this crate allows you to:
//! * Dynamically interact with Rust values
//! * Access type metadata at runtime
//! * Serialize and deserialize (i.e. save and load) data
//!
//! It's important to note that because of missing features in Rust,
//! there are some [limitations] with this crate.
//!
//! # The `Reflect` and `PartialReflect` traits
//!
//! At the root of [`bevy_reflect`] is the [`PartialReflect`] trait.
//!
//! Its purpose is to allow dynamic [introspection] of values,
//! following Rust's type system through a system of [subtraits].
//!
//! Its primary purpose is to allow all implementors to be passed around
//! as a `dyn PartialReflect` trait object in one of the following forms:
//! * `&dyn PartialReflect`
//! * `&mut dyn PartialReflect`
//! * `Box<dyn PartialReflect>`
//!
//! This allows values of types implementing `PartialReflect`
//! to be operated upon completely dynamically (at a small [runtime cost]).
//!
//! Building on `PartialReflect` is the [`Reflect`] trait.
//!
//! `PartialReflect` is a supertrait of `Reflect`
//! so any type implementing `Reflect` implements `PartialReflect` by definition.
//! `dyn Reflect` trait objects can be used similarly to `dyn PartialReflect`,
//! but `Reflect` is also often used in trait bounds (like `T: Reflect`).
//!
//! The distinction between `PartialReflect` and `Reflect` is summarized in the following:
//! * `PartialReflect` is a trait for interacting with values under `bevy_reflect`'s data model.
//!   This means values implementing `PartialReflect` can be dynamically constructed and introspected.
//! * The `Reflect` trait, however, ensures that the interface exposed by `PartialReflect`
//!   on types which additionally implement `Reflect` mirrors the structure of a single Rust type.
//! * This means `dyn Reflect` trait objects can be directly downcast to concrete types,
//!   where `dyn PartialReflect` trait object cannot.
//! * `Reflect`, since it provides a stronger type-correctness guarantee,
//!   is the trait used to interact with [the type registry].
//!
//! ## Converting between `PartialReflect` and `Reflect`
//!
//! Since `T: Reflect` implies `T: PartialReflect`, conversion from a `dyn Reflect` to a `dyn PartialReflect`
//! trait object (upcasting) is infallible and can be performed with one of the following methods.
//! Note that these are temporary while [the language feature for dyn upcasting coercion] is experimental:
//! * [`PartialReflect::as_partial_reflect`] for `&dyn PartialReflect`
//! * [`PartialReflect::as_partial_reflect_mut`] for `&mut dyn PartialReflect`
//! * [`PartialReflect::into_partial_reflect`] for `Box<dyn PartialReflect>`
//!
//! For conversion in the other direction — downcasting `dyn PartialReflect` to `dyn Reflect` —
//! there are fallible methods:
//! * [`PartialReflect::try_as_reflect`] for `&dyn Reflect`
//! * [`PartialReflect::try_as_reflect_mut`] for `&mut dyn Reflect`
//! * [`PartialReflect::try_into_reflect`] for `Box<dyn Reflect>`
//!
//! Additionally, [`FromReflect::from_reflect`] can be used to convert a `dyn PartialReflect` to a concrete type
//! which implements `Reflect`.
//!
//! # Implementing `Reflect`
//!
//! Implementing `Reflect` (and `PartialReflect`) is easily done using the provided [derive macro]:
//!
//! ```
//! # use bevy_reflect::Reflect;
//! #[derive(Reflect)]
//! struct MyStruct {
//!   foo: i32
//! }
//! ```
//!
//! This will automatically generate the implementation of `Reflect` for any struct or enum.
//!
//! It will also generate other very important trait implementations used for reflection:
//! * [`GetTypeRegistration`]
//! * [`Typed`]
//! * [`Struct`], [`TupleStruct`], or [`Enum`] depending on the type
//!
//! ## Requirements
//!
//! We can implement `Reflect` on any type that satisfies _both_ of the following conditions:
//! * The type implements `Any`, `Send`, and `Sync`.
//!   For the `Any` requirement to be satisfied, the type itself must have a [`'static` lifetime].
//! * All fields and sub-elements themselves implement `Reflect`
//!   (see the [derive macro documentation] for details on how to ignore certain fields when deriving).
//!
//! Additionally, using the derive macro on enums requires a third condition to be met:
//! * All fields and sub-elements must implement [`FromReflect`]—
//!   another important reflection trait discussed in a later section.
//!
//! # The Reflection Subtraits
//!
//! Since [`PartialReflect`] is meant to cover any and every type, this crate also comes with a few
//! more traits to accompany `PartialReflect` and provide more specific interactions.
//! We refer to these traits as the _reflection subtraits_ since they all have `PartialReflect` as a supertrait.
//! The current list of reflection subtraits include:
//! * [`Tuple`]
//! * [`Array`]
//! * [`List`]
//! * [`Set`]
//! * [`Map`]
//! * [`Struct`]
//! * [`TupleStruct`]
//! * [`Enum`]
//! * [`Function`] (requires the `functions` feature)
//!
//! As mentioned previously, the last three are automatically implemented by the [derive macro].
//!
//! Each of these traits come with their own methods specific to their respective category.
//! For example, we can access our struct's fields by name using the [`Struct::field`] method.
//!
//! ```
//! # use bevy_reflect::{PartialReflect, Reflect, Struct};
//! # #[derive(Reflect)]
//! # struct MyStruct {
//! #   foo: i32
//! # }
//! let my_struct: Box<dyn Struct> = Box::new(MyStruct {
//!   foo: 123
//! });
//! let foo: &dyn PartialReflect = my_struct.field("foo").unwrap();
//! assert_eq!(Some(&123), foo.try_downcast_ref::<i32>());
//! ```
//!
//! Since most data is passed around as `dyn PartialReflect` or `dyn Reflect` trait objects,
//! the `PartialReflect` trait has methods for going to and from these subtraits.
//!
//! [`PartialReflect::reflect_kind`], [`PartialReflect::reflect_ref`],
//! [`PartialReflect::reflect_mut`], and [`PartialReflect::reflect_owned`] all return
//! an enum that respectively contains zero-sized, immutable, mutable, and owned access to the type as a subtrait object.
//!
//! For example, we can get out a `dyn Tuple` from our reflected tuple type using one of these methods.
//!
//! ```
//! # use bevy_reflect::{PartialReflect, ReflectRef};
//! let my_tuple: Box<dyn PartialReflect> = Box::new((1, 2, 3));
//! let my_tuple = my_tuple.reflect_ref().as_tuple().unwrap();
//! assert_eq!(3, my_tuple.field_len());
//! ```
//!
//! And to go back to a general-purpose `dyn PartialReflect`,
//! we can just use the matching [`PartialReflect::as_partial_reflect`], [`PartialReflect::as_partial_reflect_mut`],
//! or [`PartialReflect::into_partial_reflect`] methods.
//!
//! ## Opaque Types
//!
//! Some types don't fall under a particular subtrait.
//!
//! These types hide their internal structure to reflection,
//! either because it is not possible, difficult, or not useful to reflect its internals.
//! Such types are known as _opaque_ types.
//!
//! This includes truly opaque types like `String` or `Instant`,
//! but also includes all the primitive types (e.g.  `bool`, `usize`, etc.)
//! since they can't be broken down any further.
//!
//! # Dynamic Types
//!
//! Each subtrait comes with a corresponding _dynamic_ type.
//!
//! The available dynamic types are:
//! * [`DynamicTuple`]
//! * [`DynamicArray`]
//! * [`DynamicList`]
//! * [`DynamicMap`]
//! * [`DynamicStruct`]
//! * [`DynamicTupleStruct`]
//! * [`DynamicEnum`]
//!
//! These dynamic types may contain any arbitrary reflected data.
//!
//! ```
//! # use bevy_reflect::{DynamicStruct, Struct};
//! let mut data = DynamicStruct::default();
//! data.insert("foo", 123_i32);
//! assert_eq!(Some(&123), data.field("foo").unwrap().try_downcast_ref::<i32>())
//! ```
//!
//! They are most commonly used as "proxies" for other types,
//! where they contain the same data as— and therefore, represent— a concrete type.
//! The [`PartialReflect::to_dynamic`] method will return a dynamic type for all non-opaque types,
//! allowing all types to essentially be "cloned" into a dynamic type.
//! And since dynamic types themselves implement [`PartialReflect`],
//! we may pass them around just like most other reflected types.
//!
//! ```
//! # use bevy_reflect::{DynamicStruct, PartialReflect, Reflect};
//! # #[derive(Reflect)]
//! # struct MyStruct {
//! #   foo: i32
//! # }
//! let original: Box<dyn Reflect> = Box::new(MyStruct {
//!   foo: 123
//! });
//!
//! // `dynamic` will be a `DynamicStruct` representing a `MyStruct`
//! let dynamic: Box<dyn PartialReflect> = original.to_dynamic();
//! assert!(dynamic.represents::<MyStruct>());
//! ```
//!
//! ## Patching
//!
//! These dynamic types come in handy when needing to apply multiple changes to another type.
//! This is known as "patching" and is done using the [`PartialReflect::apply`] and [`PartialReflect::try_apply`] methods.
//!
//! ```
//! # use bevy_reflect::{DynamicEnum, PartialReflect};
//! let mut value = Some(123_i32);
//! let patch = DynamicEnum::new("None", ());
//! value.apply(&patch);
//! assert_eq!(None, value);
//! ```
//!
//! ## `FromReflect`
//!
//! It's important to remember that dynamic types are _not_ the concrete type they may be representing.
//! A common mistake is to treat them like such when trying to cast back to the original type
//! or when trying to make use of a reflected trait which expects the actual type.
//!
//! ```should_panic
//! # use bevy_reflect::{DynamicStruct, PartialReflect, Reflect};
//! # #[derive(Reflect)]
//! # struct MyStruct {
//! #   foo: i32
//! # }
//! let original: Box<dyn Reflect> = Box::new(MyStruct {
//!   foo: 123
//! });
//!
//! let dynamic: Box<dyn PartialReflect> = original.to_dynamic();
//! let value = dynamic.try_take::<MyStruct>().unwrap(); // PANIC!
//! ```
//!
//! To resolve this issue, we'll need to convert the dynamic type to the concrete one.
//! This is where [`FromReflect`] comes in.
//!
//! `FromReflect` is a trait that allows an instance of a type to be generated from a
//! dynamic representation— even partial ones.
//! And since the [`FromReflect::from_reflect`] method takes the data by reference,
//! this can be used to effectively clone data (to an extent).
//!
//! It is automatically implemented when [deriving `Reflect`] on a type unless opted out of
//! using `#[reflect(from_reflect = false)]` on the item.
//!
//! ```
//! # use bevy_reflect::{FromReflect, PartialReflect, Reflect};
//! #[derive(Reflect)]
//! struct MyStruct {
//!   foo: i32
//! }
//! let original: Box<dyn Reflect> = Box::new(MyStruct {
//!   foo: 123
//! });
//!
//! let dynamic: Box<dyn PartialReflect> = original.to_dynamic();
//! let value = <MyStruct as FromReflect>::from_reflect(&*dynamic).unwrap(); // OK!
//! ```
//!
//! When deriving, all active fields and sub-elements must also implement `FromReflect`.
//!
//! Fields can be given default values for when a field is missing in the passed value or even ignored.
//! Ignored fields must either implement [`Default`] or have a default function specified
//! using `#[reflect(default = "path::to::function")]`.
//!
//! See the [derive macro documentation](derive@crate::FromReflect) for details.
//!
//! All primitives and simple types implement `FromReflect` by relying on their [`Default`] implementation.
//!
//! # Path navigation
//!
//! The [`GetPath`] trait allows accessing arbitrary nested fields of an [`PartialReflect`] type.
//!
//! Using `GetPath`, it is possible to use a path string to access a specific field
//! of a reflected type.
//!
//! ```
//! # use bevy_reflect::{Reflect, GetPath};
//! #[derive(Reflect)]
//! struct MyStruct {
//!   value: Vec<Option<u32>>
//! }
//!
//! let my_struct = MyStruct {
//!   value: vec![None, None, Some(123)],
//! };
//! assert_eq!(
//!   my_struct.path::<u32>(".value[2].0").unwrap(),
//!   &123,
//! );
//! ```
//!
//! # Type Registration
//!
//! This crate also comes with a [`TypeRegistry`] that can be used to store and retrieve additional type metadata at runtime,
//! such as helper types and trait implementations.
//!
//! The [derive macro] for [`Reflect`] also generates an implementation of the [`GetTypeRegistration`] trait,
//! which is used by the registry to generate a [`TypeRegistration`] struct for that type.
//! We can then register additional [type data] we want associated with that type.
//!
//! For example, we can register [`ReflectDefault`] on our type so that its `Default` implementation
//! may be used dynamically.
//!
//! ```
//! # use bevy_reflect::{Reflect, TypeRegistry, prelude::ReflectDefault};
//! #[derive(Reflect, Default)]
//! struct MyStruct {
//!   foo: i32
//! }
//! let mut registry = TypeRegistry::empty();
//! registry.register::<MyStruct>();
//! registry.register_type_data::<MyStruct, ReflectDefault>();
//!
//! let registration = registry.get(core::any::TypeId::of::<MyStruct>()).unwrap();
//! let reflect_default = registration.data::<ReflectDefault>().unwrap();
//!
//! let new_value: Box<dyn Reflect> = reflect_default.default();
//! assert!(new_value.is::<MyStruct>());
//! ```
//!
//! Because this operation is so common, the derive macro actually has a shorthand for it.
//! By using the `#[reflect(Trait)]` attribute, the derive macro will automatically register a matching,
//! in-scope `ReflectTrait` type within the `GetTypeRegistration` implementation.
//!
//! ```
//! use bevy_reflect::prelude::{Reflect, ReflectDefault};
//!
//! #[derive(Reflect, Default)]
//! #[reflect(Default)]
//! struct MyStruct {
//!   foo: i32
//! }
//! ```
//!
//! ## Reflecting Traits
//!
//! Type data doesn't have to be tied to a trait, but it's often extremely useful to create trait type data.
//! These allow traits to be used directly on a `dyn Reflect` (and not a `dyn PartialReflect`)
//! while utilizing the underlying type's implementation.
//!
//! For any [object-safe] trait, we can easily generate a corresponding `ReflectTrait` type for our trait
//! using the [`#[reflect_trait]`](reflect_trait) macro.
//!
//! ```
//! # use bevy_reflect::{Reflect, reflect_trait, TypeRegistry};
//! #[reflect_trait] // Generates a `ReflectMyTrait` type
//! pub trait MyTrait {}
//! impl<T: Reflect> MyTrait for T {}
//!
//! let mut registry = TypeRegistry::new();
//! registry.register_type_data::<i32, ReflectMyTrait>();
//! ```
//!
//! The generated type data can be used to convert a valid `dyn Reflect` into a `dyn MyTrait`.
//! See the [dynamic types example](https://github.com/bevyengine/bevy/blob/latest/examples/reflection/dynamic_types.rs)
//! for more information and usage details.
//!
//! # Serialization
//!
//! By using reflection, we are also able to get serialization capabilities for free.
//! In fact, using [`bevy_reflect`] can result in faster compile times and reduced code generation over
//! directly deriving the [`serde`] traits.
//!
//! The way it works is by moving the serialization logic into common serializers and deserializers:
//! * [`ReflectSerializer`]
//! * [`TypedReflectSerializer`]
//! * [`ReflectDeserializer`]
//! * [`TypedReflectDeserializer`]
//!
//! All of these structs require a reference to the [registry] so that [type information] can be retrieved,
//! as well as registered type data, such as [`ReflectSerialize`] and [`ReflectDeserialize`].
//!
//! The general entry point are the "untyped" versions of these structs.
//! These will automatically extract the type information and pass them into their respective "typed" version.
//!
//! The output of the `ReflectSerializer` will be a map, where the key is the [type path]
//! and the value is the serialized data.
//! The `TypedReflectSerializer` will simply output the serialized data.
//!
//! The `ReflectDeserializer` can be used to deserialize this map and return a `Box<dyn Reflect>`,
//! where the underlying type will be a dynamic type representing some concrete type (except for opaque types).
//!
//! Again, it's important to remember that dynamic types may need to be converted to their concrete counterparts
//! in order to be used in certain cases.
//! This can be achieved using [`FromReflect`].
//!
//! ```
//! # use serde::de::DeserializeSeed;
//! # use bevy_reflect::{
//! #     serde::{ReflectSerializer, ReflectDeserializer},
//! #     Reflect, PartialReflect, FromReflect, TypeRegistry
//! # };
//! #[derive(Reflect, PartialEq, Debug)]
//! struct MyStruct {
//!   foo: i32
//! }
//!
//! let original_value = MyStruct {
//!   foo: 123
//! };
//!
//! // Register
//! let mut registry = TypeRegistry::new();
//! registry.register::<MyStruct>();
//!
//! // Serialize
//! let reflect_serializer = ReflectSerializer::new(original_value.as_partial_reflect(), &registry);
//! let serialized_value: String = ron::to_string(&reflect_serializer).unwrap();
//!
//! // Deserialize
//! let reflect_deserializer = ReflectDeserializer::new(&registry);
//! let deserialized_value: Box<dyn PartialReflect> = reflect_deserializer.deserialize(
//!   &mut ron::Deserializer::from_str(&serialized_value).unwrap()
//! ).unwrap();
//!
//! // Convert
//! let converted_value = <MyStruct as FromReflect>::from_reflect(&*deserialized_value).unwrap();
//!
//! assert_eq!(original_value, converted_value);
//! ```
//!
//! # Limitations
//!
//! While this crate offers a lot in terms of adding reflection to Rust,
//! it does come with some limitations that don't make it as featureful as reflection
//! in other programming languages.
//!
//! ## Non-Static Lifetimes
//!
//! One of the most obvious limitations is the `'static` requirement.
//! Rust requires fields to define a lifetime for referenced data,
//! but [`Reflect`] requires all types to have a `'static` lifetime.
//! This makes it impossible to reflect any type with non-static borrowed data.
//!
//! ## Generic Function Reflection
//!
//! Another limitation is the inability to reflect over generic functions directly. It can be done, but will
//! typically require manual monomorphization (i.e. manually specifying the types the generic method can
//! take).
//!
//! # Features
//!
//! ## `bevy`
//!
//! | Default | Dependencies                                        |
//! | :-----: | :-------------------------------------------------: |
//! | ❌      | [`bevy_math`], [`glam`], [`indexmap`], [`smallvec`] |
//!
//! This feature makes it so that the appropriate reflection traits are implemented on all the types
//! necessary for the [Bevy] game engine.
//! enables the optional dependencies: [`bevy_math`], [`glam`], [`indexmap`], and [`smallvec`].
//! These dependencies are used by the [Bevy] game engine and must define their reflection implementations
//! within this crate due to Rust's [orphan rule].
//!
//! ## `functions`
//!
//! | Default | Dependencies                      |
//! | :-----: | :-------------------------------: |
//! | ❌      | [`bevy_reflect_derive/functions`] |
//!
//! This feature allows creating a [`DynamicFunction`] or [`DynamicFunctionMut`] from Rust functions. Dynamic
//! functions can then be called with valid [`ArgList`]s.
//!
//! For more information, read the [`func`] module docs.
//!
//! ## `documentation`
//!
//! | Default | Dependencies                                  |
//! | :-----: | :-------------------------------------------: |
//! | ❌      | [`bevy_reflect_derive/documentation`]         |
//!
//! This feature enables capturing doc comments as strings for items that [derive `Reflect`].
//! Documentation information can then be accessed at runtime on the [`TypeInfo`] of that item.
//!
//! This can be useful for generating documentation for scripting language interop or
//! for displaying tooltips in an editor.
//!
//! ## `debug`
//!
//! | Default | Dependencies                                  |
//! | :-----: | :-------------------------------------------: |
//! | ✅      | `debug_stack`                                 |
//!
//! This feature enables useful debug features for reflection.
//!
//! This includes the `debug_stack` feature,
//! which enables capturing the type stack when serializing or deserializing a type
//! and displaying it in error messages.
//!
//! ## `auto_register_inventory`/`auto_register_static`
//!
//! | Default | Dependencies                      |
//! | :-----: | :-------------------------------: |
//! | ✅      | `bevy_reflect_derive/auto_register_inventory` |
//! | ❌      | `bevy_reflect_derive/auto_register_static` |
//!
//! These features enable automatic registration of types that derive [`Reflect`].
//!
//! - `auto_register_inventory` uses `inventory` to collect types on supported platforms (Linux, macOS, iOS, FreeBSD, Android, Windows, WebAssembly).
//! - `auto_register_static` uses platform-independent way to collect types, but requires additional setup and might
//!   slow down compilation, so it should only be used on platforms not supported by `inventory`.
//!   See documentation for [`load_type_registrations`] macro for more info
//!
//! When this feature is enabled `bevy_reflect` will automatically collects all types that derive [`Reflect`] on app startup,
//! and [`TypeRegistry::register_derived_types`] can be used to register these types at any point in the program.
//! However, this does not apply to types with generics: their desired monomorphized representations must be registered manually.
//!
//! [Reflection]: https://en.wikipedia.org/wiki/Reflective_programming
//! [Bevy]: https://bevy.org/
//! [limitations]: #limitations
//! [`bevy_reflect`]: crate
//! [introspection]: https://en.wikipedia.org/wiki/Type_introspection
//! [subtraits]: #the-reflection-subtraits
//! [the type registry]: #type-registration
//! [runtime cost]: https://doc.rust-lang.org/book/ch17-02-trait-objects.html#trait-objects-perform-dynamic-dispatch
//! [the language feature for dyn upcasting coercion]: https://github.com/rust-lang/rust/issues/65991
//! [derive macro]: derive@crate::Reflect
//! [`'static` lifetime]: https://doc.rust-lang.org/rust-by-example/scope/lifetime/static_lifetime.html#trait-bound
//! [`Function`]: crate::func::Function
//! [derive macro documentation]: derive@crate::Reflect
//! [deriving `Reflect`]: derive@crate::Reflect
//! [type data]: TypeData
//! [`ReflectDefault`]: std_traits::ReflectDefault
//! [object-safe]: https://doc.rust-lang.org/reference/items/traits.html#object-safety
//! [`serde`]: ::serde
//! [`ReflectSerializer`]: serde::ReflectSerializer
//! [`TypedReflectSerializer`]: serde::TypedReflectSerializer
//! [`ReflectDeserializer`]: serde::ReflectDeserializer
//! [`TypedReflectDeserializer`]: serde::TypedReflectDeserializer
//! [registry]: TypeRegistry
//! [type information]: TypeInfo
//! [type path]: TypePath
//! [type registry]: TypeRegistry
//! [`bevy_math`]: https://docs.rs/bevy_math/latest/bevy_math/
//! [`glam`]: https://docs.rs/glam/latest/glam/
//! [`smallvec`]: https://docs.rs/smallvec/latest/smallvec/
//! [`indexmap`]: https://docs.rs/indexmap/latest/indexmap/
//! [orphan rule]: https://doc.rust-lang.org/book/ch10-02-traits.html#implementing-a-trait-on-a-type:~:text=But%20we%20can%E2%80%99t,implementation%20to%20use.
//! [`bevy_reflect_derive/documentation`]: bevy_reflect_derive
//! [`bevy_reflect_derive/functions`]: bevy_reflect_derive
//! [`DynamicFunction`]: crate::func::DynamicFunction
//! [`DynamicFunctionMut`]: crate::func::DynamicFunctionMut
//! [`ArgList`]: crate::func::ArgList
//! [derive `Reflect`]: derive@crate::Reflect

#![no_std]

#[cfg(feature = "std")]
extern crate std;

extern crate alloc;

// Required to make proc macros work in bevy itself.
extern crate self as bevy_reflect;

mod array;
mod error;
mod fields;
mod from_reflect;
#[cfg(feature = "functions")]
pub mod func;
mod is;
mod kind;
mod list;
mod map;
mod path;
mod reflect;
mod reflectable;
mod remote;
mod set;
mod struct_trait;
mod tuple;
mod tuple_struct;
mod type_info;
mod type_path;
mod type_registry;

mod impls {
    mod alloc;
    mod bevy_platform;
    mod core;
    mod foldhash;
    #[cfg(feature = "hashbrown")]
    mod hashbrown;
    mod macros;
    #[cfg(feature = "std")]
    mod std;

    #[cfg(feature = "glam")]
    mod glam;
    #[cfg(feature = "indexmap")]
    mod indexmap;
    #[cfg(feature = "petgraph")]
    mod petgraph;
    #[cfg(feature = "smallvec")]
    mod smallvec;
    #[cfg(feature = "smol_str")]
    mod smol_str;
    #[cfg(feature = "uuid")]
    mod uuid;
    #[cfg(feature = "wgpu-types")]
    mod wgpu_types;
}

pub mod attributes;
mod enums;
mod generics;
pub mod serde;
pub mod std_traits;
#[cfg(feature = "debug_stack")]
mod type_info_stack;
pub mod utility;

/// The reflect prelude.
///
/// This includes the most common types in this crate, re-exported for your convenience.
pub mod prelude {
    pub use crate::std_traits::*;

    #[doc(hidden)]
    pub use crate::{
        reflect_trait, FromReflect, GetField, GetPath, GetTupleStructField, PartialReflect,
        Reflect, ReflectDeserialize, ReflectFromReflect, ReflectPath, ReflectSerialize, Struct,
        TupleStruct, TypePath,
    };

    #[cfg(feature = "functions")]
    pub use crate::func::{Function, IntoFunction, IntoFunctionMut};
}

pub use array::*;
pub use enums::*;
pub use error::*;
pub use fields::*;
pub use from_reflect::*;
pub use generics::*;
pub use is::*;
pub use kind::*;
pub use list::*;
pub use map::*;
pub use path::*;
pub use reflect::*;
pub use reflectable::*;
pub use remote::*;
pub use set::*;
pub use struct_trait::*;
pub use tuple::*;
pub use tuple_struct::*;
pub use type_info::*;
pub use type_path::*;
pub use type_registry::*;

pub use bevy_reflect_derive::*;
pub use erased_serde;

/// Exports used by the reflection macros.
///
/// These are not meant to be used directly and are subject to breaking changes.
#[doc(hidden)]
pub mod __macro_exports {
    use crate::{
        DynamicArray, DynamicEnum, DynamicList, DynamicMap, DynamicStruct, DynamicTuple,
        DynamicTupleStruct, GetTypeRegistration, TypeRegistry,
    };

    /// Re-exports of items from the [`alloc`] crate.
    ///
    /// This is required because in `std` environments (e.g., the `std` feature is enabled)
    /// the `alloc` crate may not have been included, making its namespace unreliable.
    pub mod alloc_utils {
        pub use ::alloc::{
            borrow::{Cow, ToOwned},
            boxed::Box,
            string::ToString,
        };
    }

    /// A wrapper trait around [`GetTypeRegistration`].
    ///
    /// This trait is used by the derive macro to recursively register all type dependencies.
    /// It's used instead of `GetTypeRegistration` directly to avoid making dynamic types also
    /// implement `GetTypeRegistration` in order to be used as active fields.
    ///
    /// This trait has a blanket implementation for all types that implement `GetTypeRegistration`
    /// and manual implementations for all dynamic types (which simply do nothing).
    #[diagnostic::on_unimplemented(
        message = "`{Self}` does not implement `GetTypeRegistration` so cannot be registered for reflection",
        note = "consider annotating `{Self}` with `#[derive(Reflect)]`"
    )]
    pub trait RegisterForReflection {
        #[expect(
            unused_variables,
            reason = "The parameters here are intentionally unused by the default implementation; however, putting underscores here will result in the underscores being copied by rust-analyzer's tab completion."
        )]
        fn __register(registry: &mut TypeRegistry) {}
    }

    impl<T: GetTypeRegistration> RegisterForReflection for T {
        fn __register(registry: &mut TypeRegistry) {
            registry.register::<T>();
        }
    }

    impl RegisterForReflection for DynamicEnum {}

    impl RegisterForReflection for DynamicTupleStruct {}

    impl RegisterForReflection for DynamicStruct {}

    impl RegisterForReflection for DynamicMap {}

    impl RegisterForReflection for DynamicList {}

    impl RegisterForReflection for DynamicArray {}

    impl RegisterForReflection for DynamicTuple {}

    /// Automatic reflect registration implementation
    #[cfg(feature = "auto_register")]
    pub mod auto_register {
        pub use super::*;

        #[cfg(all(
            not(feature = "auto_register_inventory"),
            not(feature = "auto_register_static")
        ))]
        compile_error!(
            "Choosing a backend is required for automatic reflect registration. Please enable either the \"auto_register_inventory\" or the \"auto_register_static\" feature."
        );

        /// inventory impl
        #[cfg(all(
            not(feature = "auto_register_static"),
            feature = "auto_register_inventory"
        ))]
        mod __automatic_type_registration_impl {
            use super::*;

            pub use inventory;

            /// Stores type registration functions
            pub struct AutomaticReflectRegistrations(pub fn(&mut TypeRegistry));

            /// Registers all collected types.
            pub fn register_types(registry: &mut TypeRegistry) {
                #[cfg(target_family = "wasm")]
                wasm_support::init();
                for registration_fn in inventory::iter::<AutomaticReflectRegistrations> {
                    registration_fn.0(registry);
                }
            }

            inventory::collect!(AutomaticReflectRegistrations);

            #[cfg(target_family = "wasm")]
            mod wasm_support {
                use bevy_platform::sync::atomic::{AtomicBool, Ordering};

                static INIT_DONE: AtomicBool = AtomicBool::new(false);

                #[expect(unsafe_code, reason = "This function is generated by linker.")]
                unsafe extern "C" {
                    fn __wasm_call_ctors();
                }

                /// This function must be called before using [`inventory::iter`] on [`AutomaticReflectRegistrations`] to run constructors on all platforms.
                pub fn init() {
                    if INIT_DONE.swap(true, Ordering::Relaxed) {
                        return;
                    };
                    // SAFETY:
                    // This will call constructors on wasm platforms at most once (as long as `init` is the only function that calls `__wasm_call_ctors`).
                    //
                    // For more information see: https://docs.rs/inventory/latest/inventory/#webassembly-and-constructors
                    #[expect(
                        unsafe_code,
                        reason = "This function must be called to use inventory on wasm."
                    )]
                    unsafe {
                        __wasm_call_ctors();
                    }
                }
            }
        }

        /// static impl
        #[cfg(feature = "auto_register_static")]
        mod __automatic_type_registration_impl {
            use super::*;
            use alloc::vec::Vec;
            use bevy_platform::sync::Mutex;

            static REGISTRATION_FNS: Mutex<Vec<fn(&mut TypeRegistry)>> = Mutex::new(Vec::new());

            /// Adds a new registration function for [`TypeRegistry`]
            pub fn push_registration_fn(registration_fn: fn(&mut TypeRegistry)) {
                REGISTRATION_FNS.lock().unwrap().push(registration_fn);
            }

            /// Registers all collected types.
            pub fn register_types(registry: &mut TypeRegistry) {
                for func in REGISTRATION_FNS.lock().unwrap().iter() {
                    (func)(registry);
                }
            }
        }

        #[cfg(any(feature = "auto_register_static", feature = "auto_register_inventory"))]
        pub use __automatic_type_registration_impl::*;
    }
}

#[cfg(test)]
#[expect(
    clippy::approx_constant,
    reason = "We don't need the exact value of Pi here."
)]
mod tests {
    use ::serde::{de::DeserializeSeed, Deserialize, Serialize};
    use alloc::{
        borrow::Cow,
        boxed::Box,
        format,
        string::{String, ToString},
        vec,
        vec::Vec,
    };
    use bevy_platform::collections::HashMap;
    use core::{
        any::TypeId,
        fmt::{Debug, Formatter},
        hash::Hash,
        marker::PhantomData,
    };
    use disqualified::ShortName;
    use ron::{
        ser::{to_string_pretty, PrettyConfig},
        Deserializer,
    };
    use static_assertions::{assert_impl_all, assert_not_impl_all};

    use super::{prelude::*, *};
    use crate::{
        serde::{ReflectDeserializer, ReflectSerializer},
        utility::GenericTypePathCell,
    };

    #[test]
    fn try_apply_should_detect_kinds() {
        #[derive(Reflect, Debug)]
        struct Struct {
            a: u32,
            b: f32,
        }

        #[derive(Reflect, Debug)]
        enum Enum {
            A,
            B(u32),
        }

        let mut struct_target = Struct {
            a: 0xDEADBEEF,
            b: 3.14,
        };

        let mut enum_target = Enum::A;

        let array_src = [8, 0, 8];

        let result = struct_target.try_apply(&enum_target);
        assert!(
            matches!(
                result,
                Err(ApplyError::MismatchedKinds {
                    from_kind: ReflectKind::Enum,
                    to_kind: ReflectKind::Struct
                })
            ),
            "result was {result:?}"
        );

        let result = enum_target.try_apply(&array_src);
        assert!(
            matches!(
                result,
                Err(ApplyError::MismatchedKinds {
                    from_kind: ReflectKind::Array,
                    to_kind: ReflectKind::Enum
                })
            ),
            "result was {result:?}"
        );
    }

    #[test]
    fn reflect_struct() {
        #[derive(Reflect)]
        struct Foo {
            a: u32,
            b: f32,
            c: Bar,
        }
        #[derive(Reflect)]
        struct Bar {
            x: u32,
        }

        let mut foo = Foo {
            a: 42,
            b: 3.14,
            c: Bar { x: 1 },
        };

        let a = *foo.get_field::<u32>("a").unwrap();
        assert_eq!(a, 42);

        *foo.get_field_mut::<u32>("a").unwrap() += 1;
        assert_eq!(foo.a, 43);

        let bar = foo.get_field::<Bar>("c").unwrap();
        assert_eq!(bar.x, 1);

        // nested retrieval
        let c = foo.field("c").unwrap();
        let value = c.reflect_ref().as_struct().unwrap();
        assert_eq!(*value.get_field::<u32>("x").unwrap(), 1);

        // patch Foo with a dynamic struct
        let mut dynamic_struct = DynamicStruct::default();
        dynamic_struct.insert("a", 123u32);
        dynamic_struct.insert("should_be_ignored", 456);

        foo.apply(&dynamic_struct);
        assert_eq!(foo.a, 123);
    }

    #[test]
    fn reflect_map() {
        #[derive(Reflect, Hash)]
        #[reflect(Hash)]
        struct Foo {
            a: u32,
            b: String,
        }

        let key_a = Foo {
            a: 1,
            b: "k1".to_string(),
        };

        let key_b = Foo {
            a: 1,
            b: "k1".to_string(),
        };

        let key_c = Foo {
            a: 3,
            b: "k3".to_string(),
        };

        let mut map = DynamicMap::default();
        map.insert(key_a, 10u32);
        assert_eq!(
            10,
            *map.get(&key_b).unwrap().try_downcast_ref::<u32>().unwrap()
        );
        assert!(map.get(&key_c).is_none());
        *map.get_mut(&key_b)
            .unwrap()
            .try_downcast_mut::<u32>()
            .unwrap() = 20;
        assert_eq!(
            20,
            *map.get(&key_b).unwrap().try_downcast_ref::<u32>().unwrap()
        );
    }

    #[test]
    fn reflect_unit_struct() {
        #[derive(Reflect)]
        struct Foo(u32, u64);

        let mut foo = Foo(1, 2);
        assert_eq!(1, *foo.get_field::<u32>(0).unwrap());
        assert_eq!(2, *foo.get_field::<u64>(1).unwrap());

        let mut patch = DynamicTupleStruct::default();
        patch.insert(3u32);
        patch.insert(4u64);
        assert_eq!(
            3,
            *patch.field(0).unwrap().try_downcast_ref::<u32>().unwrap()
        );
        assert_eq!(
            4,
            *patch.field(1).unwrap().try_downcast_ref::<u64>().unwrap()
        );

        foo.apply(&patch);
        assert_eq!(3, foo.0);
        assert_eq!(4, foo.1);

        let mut iter = patch.iter_fields();
        assert_eq!(3, *iter.next().unwrap().try_downcast_ref::<u32>().unwrap());
        assert_eq!(4, *iter.next().unwrap().try_downcast_ref::<u64>().unwrap());
    }

    #[test]
    #[should_panic(
        expected = "the given key of type `bevy_reflect::tests::Foo` does not support hashing"
    )]
    fn reflect_map_no_hash() {
        #[derive(Reflect)]
        struct Foo {
            a: u32,
        }

        let foo = Foo { a: 1 };
        assert!(foo.reflect_hash().is_none());

        let mut map = DynamicMap::default();
        map.insert(foo, 10u32);
    }

    #[test]
    #[should_panic(
        expected = "the dynamic type `bevy_reflect::DynamicStruct` (representing `bevy_reflect::tests::Foo`) does not support hashing"
    )]
    fn reflect_map_no_hash_dynamic_representing() {
        #[derive(Reflect, Hash)]
        #[reflect(Hash)]
        struct Foo {
            a: u32,
        }

        let foo = Foo { a: 1 };
        assert!(foo.reflect_hash().is_some());
        let dynamic = foo.to_dynamic_struct();

        let mut map = DynamicMap::default();
        map.insert(dynamic, 11u32);
    }

    #[test]
    #[should_panic(
        expected = "the dynamic type `bevy_reflect::DynamicStruct` does not support hashing"
    )]
    fn reflect_map_no_hash_dynamic() {
        #[allow(
            clippy::allow_attributes,
            dead_code,
            reason = "This struct is used as a compilation test to test the derive macros, and as such is intentionally never constructed."
        )]
        #[derive(Reflect, Hash)]
        #[reflect(Hash)]
        struct Foo {
            a: u32,
        }

        let mut dynamic = DynamicStruct::default();
        dynamic.insert("a", 4u32);
        assert!(dynamic.reflect_hash().is_none());

        let mut map = DynamicMap::default();
        map.insert(dynamic, 11u32);
    }

    #[test]
    fn reflect_ignore() {
        #[derive(Reflect)]
        struct Foo {
            a: u32,
            #[reflect(ignore)]
            _b: u32,
        }

        let foo = Foo { a: 1, _b: 2 };

        let values: Vec<u32> = foo
            .iter_fields()
            .map(|value| *value.try_downcast_ref::<u32>().unwrap())
            .collect();
        assert_eq!(values, vec![1]);
    }

    /// This test ensures that we are able to reflect generic types with one or more type parameters.
    ///
    /// When there is an `Add` implementation for `String`, the compiler isn't able to infer the correct
    /// type to deref to.
    /// If we don't append the strings in the `TypePath` derive correctly (i.e. explicitly specifying the type),
    /// we'll get a compilation error saying that "`&String` cannot be added to `String`".
    ///
    /// So this test just ensures that we do that correctly.
    ///
    /// This problem is a known issue and is unexpectedly expected behavior:
    /// - <https://github.com/rust-lang/rust/issues/77143>
    /// - <https://github.com/bodil/smartstring/issues/7>
    /// - <https://github.com/pola-rs/polars/issues/14666>
    #[test]
    fn should_reflect_generic() {
        struct FakeString {}

        // This implementation confuses the compiler when trying to add a `&String` to a `String`
        impl core::ops::Add<FakeString> for String {
            type Output = Self;
            fn add(self, _rhs: FakeString) -> Self::Output {
                unreachable!()
            }
        }

        #[expect(
            dead_code,
            reason = "This struct is used as a compilation test to test the derive macros, and as such is intentionally never constructed."
        )]
        #[derive(Reflect)]
        struct Foo<A>(A);

        #[expect(
            dead_code,
            reason = "This struct is used as a compilation test to test the derive macros, and as such is intentionally never constructed."
        )]
        #[derive(Reflect)]
        struct Bar<A, B>(A, B);

        #[expect(
            dead_code,
            reason = "This struct is used as a compilation test to test the derive macros, and as such is intentionally never constructed."
        )]
        #[derive(Reflect)]
        struct Baz<A, B, C>(A, B, C);
    }

    #[test]
    fn should_reflect_clone() {
        // Struct
        #[derive(Reflect, Debug, PartialEq)]
        struct Foo(usize);

        let value = Foo(123);
        let clone = value.reflect_clone().expect("should reflect_clone struct");
        assert_eq!(value, clone.take::<Foo>().unwrap());

        // Tuple
        let foo = (123, 4.56);
        let clone = foo.reflect_clone().expect("should reflect_clone tuple");
        assert_eq!(foo, clone.take::<(u32, f32)>().unwrap());
    }

    #[test]
    fn should_reflect_clone_generic_type() {
        #[derive(Reflect, Debug, PartialEq)]
        struct Foo<T, U>(T, #[reflect(ignore, clone)] PhantomData<U>);
        #[derive(TypePath, Debug, PartialEq)]
        struct Bar;

        // `usize` will be cloned via `Reflect::reflect_clone`
        // `PhantomData<Bar>` will be cloned via `Clone::clone`
        let value = Foo::<usize, Bar>(123, PhantomData);
        let clone = value
            .reflect_clone()
            .expect("should reflect_clone generic struct");
        assert_eq!(value, clone.take::<Foo<usize, Bar>>().unwrap());
    }

    #[test]
    fn should_reflect_clone_with_clone() {
        // A custom clone function to verify that the `#[reflect(Clone)]` container attribute
        // takes precedence over the `#[reflect(clone)]` field attribute.
        #[expect(
            dead_code,
            reason = "if things are working correctly, this function should never be called"
        )]
        fn custom_clone(_value: &usize) -> usize {
            panic!("should not be called");
        }

        // Tuple Struct
        #[derive(Reflect, Clone, Debug, PartialEq)]
        #[reflect(Clone)]
        struct Foo(#[reflect(clone = "custom_clone")] usize);

        let value = Foo(123);
        let clone = value
            .reflect_clone()
            .expect("should reflect_clone tuple struct");
        assert_eq!(value, clone.take::<Foo>().unwrap());

        // Struct
        #[derive(Reflect, Clone, Debug, PartialEq)]
        #[reflect(Clone)]
        struct Bar {
            #[reflect(clone = "custom_clone")]
            value: usize,
        }

        let value = Bar { value: 123 };
        let clone = value.reflect_clone().expect("should reflect_clone struct");
        assert_eq!(value, clone.take::<Bar>().unwrap());

        // Enum
        #[derive(Reflect, Clone, Debug, PartialEq)]
        #[reflect(Clone)]
        enum Baz {
            Unit,
            Tuple(#[reflect(clone = "custom_clone")] usize),
            Struct {
                #[reflect(clone = "custom_clone")]
                value: usize,
            },
        }

        let value = Baz::Unit;
        let clone = value
            .reflect_clone()
            .expect("should reflect_clone unit variant");
        assert_eq!(value, clone.take::<Baz>().unwrap());

        let value = Baz::Tuple(123);
        let clone = value
            .reflect_clone()
            .expect("should reflect_clone tuple variant");
        assert_eq!(value, clone.take::<Baz>().unwrap());

        let value = Baz::Struct { value: 123 };
        let clone = value
            .reflect_clone()
            .expect("should reflect_clone struct variant");
        assert_eq!(value, clone.take::<Baz>().unwrap());
    }

    #[test]
    fn should_custom_reflect_clone() {
        #[derive(Reflect, Debug, PartialEq)]
        #[reflect(Clone(clone_foo))]
        struct Foo(usize);

        fn clone_foo(foo: &Foo) -> Foo {
            Foo(foo.0 + 198)
        }

        let foo = Foo(123);
        let clone = foo.reflect_clone().unwrap();
        assert_eq!(Foo(321), clone.take::<Foo>().unwrap());
    }

    #[test]
    fn should_not_clone_ignored_fields() {
        // Tuple Struct
        #[derive(Reflect, Clone, Debug, PartialEq)]
        struct Foo(#[reflect(ignore)] usize);

        let foo = Foo(123);
        let clone = foo.reflect_clone();
        assert_eq!(
            clone.unwrap_err(),
            ReflectCloneError::FieldNotCloneable {
                field: FieldId::Unnamed(0),
                variant: None,
                container_type_path: Cow::Borrowed(Foo::type_path()),
            }
        );

        // Struct
        #[derive(Reflect, Clone, Debug, PartialEq)]
        struct Bar {
            #[reflect(ignore)]
            value: usize,
        }

        let bar = Bar { value: 123 };
        let clone = bar.reflect_clone();
        assert_eq!(
            clone.unwrap_err(),
            ReflectCloneError::FieldNotCloneable {
                field: FieldId::Named(Cow::Borrowed("value")),
                variant: None,
                container_type_path: Cow::Borrowed(Bar::type_path()),
            }
        );

        // Enum
        #[derive(Reflect, Clone, Debug, PartialEq)]
        enum Baz {
            Tuple(#[reflect(ignore)] usize),
            Struct {
                #[reflect(ignore)]
                value: usize,
            },
        }

        let baz = Baz::Tuple(123);
        let clone = baz.reflect_clone();
        assert_eq!(
            clone.unwrap_err(),
            ReflectCloneError::FieldNotCloneable {
                field: FieldId::Unnamed(0),
                variant: Some(Cow::Borrowed("Tuple")),
                container_type_path: Cow::Borrowed(Baz::type_path()),
            }
        );

        let baz = Baz::Struct { value: 123 };
        let clone = baz.reflect_clone();
        assert_eq!(
            clone.unwrap_err(),
            ReflectCloneError::FieldNotCloneable {
                field: FieldId::Named(Cow::Borrowed("value")),
                variant: Some(Cow::Borrowed("Struct")),
                container_type_path: Cow::Borrowed(Baz::type_path()),
            }
        );
    }

    #[test]
    fn should_clone_ignored_fields_with_clone_attributes() {
        #[derive(Reflect, Clone, Debug, PartialEq)]
        struct Foo(#[reflect(ignore, clone)] usize);

        let foo = Foo(123);
        let clone = foo.reflect_clone().unwrap();
        assert_eq!(Foo(123), clone.take::<Foo>().unwrap());

        #[derive(Reflect, Clone, Debug, PartialEq)]
        struct Bar(#[reflect(ignore, clone = "clone_usize")] usize);

        fn clone_usize(this: &usize) -> usize {
            *this + 198
        }

        let bar = Bar(123);
        let clone = bar.reflect_clone().unwrap();
        assert_eq!(Bar(321), clone.take::<Bar>().unwrap());
    }

    #[test]
    fn should_composite_reflect_clone() {
        #[derive(Reflect, Debug, PartialEq)]
        enum MyEnum {
            Unit,
            Tuple(
                Foo,
                #[reflect(ignore, clone)] Bar,
                #[reflect(clone = "clone_baz")] Baz,
            ),
            Struct {
                foo: Foo,
                #[reflect(ignore, clone)]
                bar: Bar,
                #[reflect(clone = "clone_baz")]
                baz: Baz,
            },
        }

        #[derive(Reflect, Debug, PartialEq)]
        struct Foo {
            #[reflect(clone = "clone_bar")]
            bar: Bar,
            baz: Baz,
        }

        #[derive(Reflect, Default, Clone, Debug, PartialEq)]
        #[reflect(Clone)]
        struct Bar(String);

        #[derive(Reflect, Debug, PartialEq)]
        struct Baz(String);

        fn clone_bar(bar: &Bar) -> Bar {
            Bar(format!("{}!", bar.0))
        }

        fn clone_baz(baz: &Baz) -> Baz {
            Baz(format!("{}!", baz.0))
        }

        let my_enum = MyEnum::Unit;
        let clone = my_enum.reflect_clone().unwrap();
        assert_eq!(MyEnum::Unit, clone.take::<MyEnum>().unwrap());

        let my_enum = MyEnum::Tuple(
            Foo {
                bar: Bar("bar".to_string()),
                baz: Baz("baz".to_string()),
            },
            Bar("bar".to_string()),
            Baz("baz".to_string()),
        );
        let clone = my_enum.reflect_clone().unwrap();
        assert_eq!(
            MyEnum::Tuple(
                Foo {
                    bar: Bar("bar!".to_string()),
                    baz: Baz("baz".to_string()),
                },
                Bar("bar".to_string()),
                Baz("baz!".to_string()),
            ),
            clone.take::<MyEnum>().unwrap()
        );

        let my_enum = MyEnum::Struct {
            foo: Foo {
                bar: Bar("bar".to_string()),
                baz: Baz("baz".to_string()),
            },
            bar: Bar("bar".to_string()),
            baz: Baz("baz".to_string()),
        };
        let clone = my_enum.reflect_clone().unwrap();
        assert_eq!(
            MyEnum::Struct {
                foo: Foo {
                    bar: Bar("bar!".to_string()),
                    baz: Baz("baz".to_string()),
                },
                bar: Bar("bar".to_string()),
                baz: Baz("baz!".to_string()),
            },
            clone.take::<MyEnum>().unwrap()
        );
    }

    #[test]
    fn should_call_from_reflect_dynamically() {
        #[derive(Reflect)]
        struct MyStruct {
            foo: usize,
        }

        // Register
        let mut registry = TypeRegistry::default();
        registry.register::<MyStruct>();

        // Get type data
        let type_id = TypeId::of::<MyStruct>();
        let rfr = registry
            .get_type_data::<ReflectFromReflect>(type_id)
            .expect("the FromReflect trait should be registered");

        // Call from_reflect
        let mut dynamic_struct = DynamicStruct::default();
        dynamic_struct.insert("foo", 123usize);
        let reflected = rfr
            .from_reflect(&dynamic_struct)
            .expect("the type should be properly reflected");

        // Assert
        let expected = MyStruct { foo: 123 };
        assert!(expected
            .reflect_partial_eq(reflected.as_partial_reflect())
            .unwrap_or_default());
        let not_expected = MyStruct { foo: 321 };
        assert!(!not_expected
            .reflect_partial_eq(reflected.as_partial_reflect())
            .unwrap_or_default());
    }

    #[test]
    fn from_reflect_should_allow_ignored_unnamed_fields() {
        #[derive(Reflect, Eq, PartialEq, Debug)]
        struct MyTupleStruct(i8, #[reflect(ignore)] i16, i32);

        let expected = MyTupleStruct(1, 0, 3);

        let mut dyn_tuple_struct = DynamicTupleStruct::default();
        dyn_tuple_struct.insert(1_i8);
        dyn_tuple_struct.insert(3_i32);
        let my_tuple_struct = <MyTupleStruct as FromReflect>::from_reflect(&dyn_tuple_struct);

        assert_eq!(Some(expected), my_tuple_struct);

        #[derive(Reflect, Eq, PartialEq, Debug)]
        enum MyEnum {
            Tuple(i8, #[reflect(ignore)] i16, i32),
        }

        let expected = MyEnum::Tuple(1, 0, 3);

        let mut dyn_tuple = DynamicTuple::default();
        dyn_tuple.insert(1_i8);
        dyn_tuple.insert(3_i32);

        let mut dyn_enum = DynamicEnum::default();
        dyn_enum.set_variant("Tuple", dyn_tuple);

        let my_enum = <MyEnum as FromReflect>::from_reflect(&dyn_enum);

        assert_eq!(Some(expected), my_enum);
    }

    #[test]
    fn from_reflect_should_use_default_field_attributes() {
        #[derive(Reflect, Eq, PartialEq, Debug)]
        struct MyStruct {
            // Use `Default::default()`
            // Note that this isn't an ignored field
            #[reflect(default)]
            foo: String,

            // Use `get_bar_default()`
            #[reflect(ignore)]
            #[reflect(default = "get_bar_default")]
            bar: NotReflect,

            // Ensure attributes can be combined
            #[reflect(ignore, default = "get_bar_default")]
            baz: NotReflect,
        }

        #[derive(Eq, PartialEq, Debug)]
        struct NotReflect(usize);

        fn get_bar_default() -> NotReflect {
            NotReflect(123)
        }

        let expected = MyStruct {
            foo: String::default(),
            bar: NotReflect(123),
            baz: NotReflect(123),
        };

        let dyn_struct = DynamicStruct::default();
        let my_struct = <MyStruct as FromReflect>::from_reflect(&dyn_struct);

        assert_eq!(Some(expected), my_struct);
    }

    #[test]
    fn from_reflect_should_use_default_variant_field_attributes() {
        #[derive(Reflect, Eq, PartialEq, Debug)]
        enum MyEnum {
            Foo(#[reflect(default)] String),
            Bar {
                #[reflect(default = "get_baz_default")]
                #[reflect(ignore)]
                baz: usize,
            },
        }

        fn get_baz_default() -> usize {
            123
        }

        let expected = MyEnum::Foo(String::default());

        let dyn_enum = DynamicEnum::new("Foo", DynamicTuple::default());
        let my_enum = <MyEnum as FromReflect>::from_reflect(&dyn_enum);

        assert_eq!(Some(expected), my_enum);

        let expected = MyEnum::Bar {
            baz: get_baz_default(),
        };

        let dyn_enum = DynamicEnum::new("Bar", DynamicStruct::default());
        let my_enum = <MyEnum as FromReflect>::from_reflect(&dyn_enum);

        assert_eq!(Some(expected), my_enum);
    }

    #[test]
    fn from_reflect_should_use_default_container_attribute() {
        #[derive(Reflect, Eq, PartialEq, Debug)]
        #[reflect(Default)]
        struct MyStruct {
            foo: String,
            #[reflect(ignore)]
            bar: usize,
        }

        impl Default for MyStruct {
            fn default() -> Self {
                Self {
                    foo: String::from("Hello"),
                    bar: 123,
                }
            }
        }

        let expected = MyStruct {
            foo: String::from("Hello"),
            bar: 123,
        };

        let dyn_struct = DynamicStruct::default();
        let my_struct = <MyStruct as FromReflect>::from_reflect(&dyn_struct);

        assert_eq!(Some(expected), my_struct);
    }

    #[test]
    fn reflect_complex_patch() {
        #[derive(Reflect, Eq, PartialEq, Debug)]
        #[reflect(PartialEq)]
        struct Foo {
            a: u32,
            #[reflect(ignore)]
            _b: u32,
            c: Vec<isize>,
            d: HashMap<usize, i8>,
            e: Bar,
            f: (i32, Vec<isize>, Bar),
            g: Vec<(Baz, HashMap<usize, Bar>)>,
            h: [u32; 2],
        }

        #[derive(Reflect, Eq, PartialEq, Clone, Debug)]
        #[reflect(PartialEq)]
        struct Bar {
            x: u32,
        }

        #[derive(Reflect, Eq, PartialEq, Debug)]
        struct Baz(String);

        let mut hash_map = <HashMap<_, _>>::default();
        hash_map.insert(1, 1);
        hash_map.insert(2, 2);

        let mut hash_map_baz = <HashMap<_, _>>::default();
        hash_map_baz.insert(1, Bar { x: 0 });

        let mut foo = Foo {
            a: 1,
            _b: 1,
            c: vec![1, 2],
            d: hash_map,
            e: Bar { x: 1 },
            f: (1, vec![1, 2], Bar { x: 1 }),
            g: vec![(Baz("string".to_string()), hash_map_baz)],
            h: [2; 2],
        };

        let mut foo_patch = DynamicStruct::default();
        foo_patch.insert("a", 2u32);
        foo_patch.insert("b", 2u32); // this should be ignored

        let mut list = DynamicList::default();
        list.push(3isize);
        list.push(4isize);
        list.push(5isize);
        foo_patch.insert("c", list.to_dynamic_list());

        let mut map = DynamicMap::default();
        map.insert(2usize, 3i8);
        map.insert(3usize, 4i8);
        foo_patch.insert("d", map);

        let mut bar_patch = DynamicStruct::default();
        bar_patch.insert("x", 2u32);
        foo_patch.insert("e", bar_patch.to_dynamic_struct());

        let mut tuple = DynamicTuple::default();
        tuple.insert(2i32);
        tuple.insert(list);
        tuple.insert(bar_patch);
        foo_patch.insert("f", tuple);

        let mut composite = DynamicList::default();
        composite.push({
            let mut tuple = DynamicTuple::default();
            tuple.insert({
                let mut tuple_struct = DynamicTupleStruct::default();
                tuple_struct.insert("new_string".to_string());
                tuple_struct
            });
            tuple.insert({
                let mut map = DynamicMap::default();
                map.insert(1usize, {
                    let mut struct_ = DynamicStruct::default();
                    struct_.insert("x", 7u32);
                    struct_
                });
                map
            });
            tuple
        });
        foo_patch.insert("g", composite);

        let array = DynamicArray::from_iter([2u32, 2u32]);
        foo_patch.insert("h", array);

        foo.apply(&foo_patch);

        let mut hash_map = <HashMap<_, _>>::default();
        hash_map.insert(2, 3);
        hash_map.insert(3, 4);

        let mut hash_map_baz = <HashMap<_, _>>::default();
        hash_map_baz.insert(1, Bar { x: 7 });

        let expected_foo = Foo {
            a: 2,
            _b: 1,
            c: vec![3, 4, 5],
            d: hash_map,
            e: Bar { x: 2 },
            f: (2, vec![3, 4, 5], Bar { x: 2 }),
            g: vec![(Baz("new_string".to_string()), hash_map_baz.clone())],
            h: [2; 2],
        };

        assert_eq!(foo, expected_foo);

        let new_foo = Foo::from_reflect(&foo_patch)
            .expect("error while creating a concrete type from a dynamic type");

        let mut hash_map = <HashMap<_, _>>::default();
        hash_map.insert(2, 3);
        hash_map.insert(3, 4);

        let expected_new_foo = Foo {
            a: 2,
            _b: 0,
            c: vec![3, 4, 5],
            d: hash_map,
            e: Bar { x: 2 },
            f: (2, vec![3, 4, 5], Bar { x: 2 }),
            g: vec![(Baz("new_string".to_string()), hash_map_baz)],
            h: [2; 2],
        };

        assert_eq!(new_foo, expected_new_foo);
    }

    #[test]
    fn should_auto_register_fields() {
        #[derive(Reflect)]
        struct Foo {
            bar: Bar,
        }

        #[derive(Reflect)]
        enum Bar {
            Variant(Baz),
        }

        #[derive(Reflect)]
        struct Baz(usize);

        // === Basic === //
        let mut registry = TypeRegistry::empty();
        registry.register::<Foo>();

        assert!(
            registry.contains(TypeId::of::<Bar>()),
            "registry should contain auto-registered `Bar` from `Foo`"
        );

        // === Option === //
        let mut registry = TypeRegistry::empty();
        registry.register::<Option<Foo>>();

        assert!(
            registry.contains(TypeId::of::<Bar>()),
            "registry should contain auto-registered `Bar` from `Option<Foo>`"
        );

        // === Tuple === //
        let mut registry = TypeRegistry::empty();
        registry.register::<(Foo, Foo)>();

        assert!(
            registry.contains(TypeId::of::<Bar>()),
            "registry should contain auto-registered `Bar` from `(Foo, Foo)`"
        );

        // === Array === //
        let mut registry = TypeRegistry::empty();
        registry.register::<[Foo; 3]>();

        assert!(
            registry.contains(TypeId::of::<Bar>()),
            "registry should contain auto-registered `Bar` from `[Foo; 3]`"
        );

        // === Vec === //
        let mut registry = TypeRegistry::empty();
        registry.register::<Vec<Foo>>();

        assert!(
            registry.contains(TypeId::of::<Bar>()),
            "registry should contain auto-registered `Bar` from `Vec<Foo>`"
        );

        // === HashMap === //
        let mut registry = TypeRegistry::empty();
        registry.register::<HashMap<i32, Foo>>();

        assert!(
            registry.contains(TypeId::of::<Bar>()),
            "registry should contain auto-registered `Bar` from `HashMap<i32, Foo>`"
        );
    }

    #[test]
    fn should_allow_dynamic_fields() {
        #[derive(Reflect)]
        #[reflect(from_reflect = false)]
        struct MyStruct(
            DynamicEnum,
            DynamicTupleStruct,
            DynamicStruct,
            DynamicMap,
            DynamicList,
            DynamicArray,
            DynamicTuple,
            i32,
        );

        assert_impl_all!(MyStruct: Reflect, GetTypeRegistration);

        let mut registry = TypeRegistry::empty();
        registry.register::<MyStruct>();

        assert_eq!(2, registry.iter().count());
        assert!(registry.contains(TypeId::of::<MyStruct>()));
        assert!(registry.contains(TypeId::of::<i32>()));
    }

    #[test]
    fn should_not_auto_register_existing_types() {
        #[derive(Reflect)]
        struct Foo {
            bar: Bar,
        }

        #[derive(Reflect, Default)]
        struct Bar(usize);

        let mut registry = TypeRegistry::empty();
        registry.register::<Bar>();
        registry.register_type_data::<Bar, ReflectDefault>();
        registry.register::<Foo>();

        assert!(
            registry
                .get_type_data::<ReflectDefault>(TypeId::of::<Bar>())
                .is_some(),
            "registry should contain existing registration for `Bar`"
        );
    }

    #[test]
    fn reflect_serialize() {
        #[derive(Reflect)]
        struct Foo {
            a: u32,
            #[reflect(ignore)]
            _b: u32,
            c: Vec<isize>,
            d: HashMap<usize, i8>,
            e: Bar,
            f: String,
            g: (i32, Vec<isize>, Bar),
            h: [u32; 2],
        }

        #[derive(Reflect, Serialize, Deserialize)]
        #[reflect(Serialize, Deserialize)]
        struct Bar {
            x: u32,
        }

        let mut hash_map = <HashMap<_, _>>::default();
        hash_map.insert(1, 1);
        hash_map.insert(2, 2);
        let foo = Foo {
            a: 1,
            _b: 1,
            c: vec![1, 2],
            d: hash_map,
            e: Bar { x: 1 },
            f: "hi".to_string(),
            g: (1, vec![1, 2], Bar { x: 1 }),
            h: [2; 2],
        };

        let mut registry = TypeRegistry::default();
        registry.register::<u32>();
        registry.register::<i8>();
        registry.register::<i32>();
        registry.register::<usize>();
        registry.register::<isize>();
        registry.register::<Foo>();
        registry.register::<Bar>();
        registry.register::<String>();
        registry.register::<Vec<isize>>();
        registry.register::<HashMap<usize, i8>>();
        registry.register::<(i32, Vec<isize>, Bar)>();
        registry.register::<[u32; 2]>();

        let serializer = ReflectSerializer::new(&foo, &registry);
        let serialized = to_string_pretty(&serializer, PrettyConfig::default()).unwrap();

        let mut deserializer = Deserializer::from_str(&serialized).unwrap();
        let reflect_deserializer = ReflectDeserializer::new(&registry);
        let value = reflect_deserializer.deserialize(&mut deserializer).unwrap();
        let roundtrip_foo = Foo::from_reflect(value.as_partial_reflect()).unwrap();

        assert!(foo.reflect_partial_eq(&roundtrip_foo).unwrap());
    }

    #[test]
    fn reflect_downcast() {
        #[derive(Reflect, Clone, Debug, PartialEq)]
        struct Bar {
            y: u8,
        }

        #[derive(Reflect, Clone, Debug, PartialEq)]
        struct Foo {
            x: i32,
            s: String,
            b: Bar,
            u: usize,
            t: ([f32; 3], String),
            v: Cow<'static, str>,
            w: Cow<'static, [u8]>,
        }

        let foo = Foo {
            x: 123,
            s: "String".to_string(),
            b: Bar { y: 255 },
            u: 1111111111111,
            t: ([3.0, 2.0, 1.0], "Tuple String".to_string()),
            v: Cow::Owned("Cow String".to_string()),
            w: Cow::Owned(vec![1, 2, 3]),
        };

        let foo2: Box<dyn Reflect> = Box::new(foo.clone());

        assert_eq!(foo, *foo2.downcast::<Foo>().unwrap());
    }

    #[test]
    fn should_drain_fields() {
        let array_value: Box<dyn Array> = Box::new([123_i32, 321_i32]);
        let fields = array_value.drain();
        assert!(fields[0].reflect_partial_eq(&123_i32).unwrap_or_default());
        assert!(fields[1].reflect_partial_eq(&321_i32).unwrap_or_default());

        let mut list_value: Box<dyn List> = Box::new(vec![123_i32, 321_i32]);
        let fields = list_value.drain();
        assert!(fields[0].reflect_partial_eq(&123_i32).unwrap_or_default());
        assert!(fields[1].reflect_partial_eq(&321_i32).unwrap_or_default());

        let tuple_value: Box<dyn Tuple> = Box::new((123_i32, 321_i32));
        let fields = tuple_value.drain();
        assert!(fields[0].reflect_partial_eq(&123_i32).unwrap_or_default());
        assert!(fields[1].reflect_partial_eq(&321_i32).unwrap_or_default());

        let mut map_value: Box<dyn Map> =
            Box::new([(123_i32, 321_i32)].into_iter().collect::<HashMap<_, _>>());
        let fields = map_value.drain();
        assert!(fields[0].0.reflect_partial_eq(&123_i32).unwrap_or_default());
        assert!(fields[0].1.reflect_partial_eq(&321_i32).unwrap_or_default());
    }

    #[test]
    fn reflect_take() {
        #[derive(Reflect, Debug, PartialEq)]
        #[reflect(PartialEq)]
        struct Bar {
            x: u32,
        }

        let x: Box<dyn Reflect> = Box::new(Bar { x: 2 });
        let y = x.take::<Bar>().unwrap();
        assert_eq!(y, Bar { x: 2 });
    }

    #[test]
    fn not_dynamic_names() {
        let list = Vec::<usize>::new();
        let dyn_list = list.to_dynamic_list();
        assert_ne!(dyn_list.reflect_type_path(), Vec::<usize>::type_path());

        let array = [b'0'; 4];
        let dyn_array = array.to_dynamic_array();
        assert_ne!(dyn_array.reflect_type_path(), <[u8; 4]>::type_path());

        let map = HashMap::<usize, String>::default();
        let dyn_map = map.to_dynamic_map();
        assert_ne!(
            dyn_map.reflect_type_path(),
            HashMap::<usize, String>::type_path()
        );

        let tuple = (0usize, "1".to_string(), 2.0f32);
        let mut dyn_tuple = tuple.to_dynamic_tuple();
        dyn_tuple.insert::<usize>(3);
        assert_ne!(
            dyn_tuple.reflect_type_path(),
            <(usize, String, f32, usize)>::type_path()
        );

        #[derive(Reflect)]
        struct TestStruct {
            a: usize,
        }
        let struct_ = TestStruct { a: 0 };
        let dyn_struct = struct_.to_dynamic_struct();
        assert_ne!(dyn_struct.reflect_type_path(), TestStruct::type_path());

        #[derive(Reflect)]
        struct TestTupleStruct(usize);
        let tuple_struct = TestTupleStruct(0);
        let dyn_tuple_struct = tuple_struct.to_dynamic_tuple_struct();
        assert_ne!(
            dyn_tuple_struct.reflect_type_path(),
            TestTupleStruct::type_path()
        );
    }

    macro_rules! assert_type_paths {
        ($($ty:ty => $long:literal, $short:literal,)*) => {
            $(
                assert_eq!(<$ty as TypePath>::type_path(), $long);
                assert_eq!(<$ty as TypePath>::short_type_path(), $short);
            )*
        };
    }

    #[test]
    fn reflect_type_path() {
        #[derive(TypePath)]
        struct Param;

        #[derive(TypePath)]
        struct Derive;

        #[derive(TypePath)]
        #[type_path = "my_alias"]
        struct DerivePath;

        #[derive(TypePath)]
        #[type_path = "my_alias"]
        #[type_name = "MyDerivePathName"]
        struct DerivePathName;

        #[derive(TypePath)]
        struct DeriveG<T>(PhantomData<T>);

        #[derive(TypePath)]
        #[type_path = "my_alias"]
        struct DerivePathG<T, const N: usize>(PhantomData<T>);

        #[derive(TypePath)]
        #[type_path = "my_alias"]
        #[type_name = "MyDerivePathNameG"]
        struct DerivePathNameG<T>(PhantomData<T>);

        struct Macro;
        impl_type_path!((in my_alias) Macro);

        struct MacroName;
        impl_type_path!((in my_alias as MyMacroName) MacroName);

        struct MacroG<T, const N: usize>(PhantomData<T>);
        impl_type_path!((in my_alias) MacroG<T, const N: usize>);

        struct MacroNameG<T>(PhantomData<T>);
        impl_type_path!((in my_alias as MyMacroNameG) MacroNameG<T>);

        assert_type_paths! {
            Derive => "bevy_reflect::tests::Derive", "Derive",
            DerivePath => "my_alias::DerivePath", "DerivePath",
            DerivePathName => "my_alias::MyDerivePathName", "MyDerivePathName",
            DeriveG<Param> => "bevy_reflect::tests::DeriveG<bevy_reflect::tests::Param>", "DeriveG<Param>",
            DerivePathG<Param, 10> => "my_alias::DerivePathG<bevy_reflect::tests::Param, 10>", "DerivePathG<Param, 10>",
            DerivePathNameG<Param> => "my_alias::MyDerivePathNameG<bevy_reflect::tests::Param>", "MyDerivePathNameG<Param>",
            Macro => "my_alias::Macro", "Macro",
            MacroName => "my_alias::MyMacroName", "MyMacroName",
            MacroG<Param, 10> => "my_alias::MacroG<bevy_reflect::tests::Param, 10>", "MacroG<Param, 10>",
            MacroNameG<Param> => "my_alias::MyMacroNameG<bevy_reflect::tests::Param>", "MyMacroNameG<Param>",
        }
    }

    #[test]
    fn std_type_paths() {
        #[derive(Clone)]
        struct Type;

        impl TypePath for Type {
            fn type_path() -> &'static str {
                // for brevity in tests
                "Long"
            }

            fn short_type_path() -> &'static str {
                "Short"
            }
        }

        assert_type_paths! {
            u8 => "u8", "u8",
            Type => "Long", "Short",
            &Type => "&Long", "&Short",
            [Type] => "[Long]", "[Short]",
            &[Type] => "&[Long]", "&[Short]",
            [Type; 0] => "[Long; 0]", "[Short; 0]",
            [Type; 100] => "[Long; 100]", "[Short; 100]",
            () => "()", "()",
            (Type,) => "(Long,)", "(Short,)",
            (Type, Type) => "(Long, Long)", "(Short, Short)",
            (Type, Type, Type) => "(Long, Long, Long)", "(Short, Short, Short)",
            Cow<'static, Type> => "alloc::borrow::Cow<Long>", "Cow<Short>",
        }
    }

    #[test]
    fn reflect_type_info() {
        // TypeInfo
        let info = i32::type_info();
        assert_eq!(i32::type_path(), info.type_path());
        assert_eq!(TypeId::of::<i32>(), info.type_id());

        // TypeInfo (unsized)
        assert_eq!(
            TypeId::of::<dyn Reflect>(),
            <dyn Reflect as Typed>::type_info().type_id()
        );

        // TypeInfo (instance)
        let value: &dyn Reflect = &123_i32;
        let info = value.reflect_type_info();
        assert!(info.is::<i32>());

        // Struct
        #[derive(Reflect)]
        struct MyStruct {
            foo: i32,
            bar: usize,
        }

        let info = MyStruct::type_info().as_struct().unwrap();
        assert!(info.is::<MyStruct>());
        assert_eq!(MyStruct::type_path(), info.type_path());
        assert_eq!(i32::type_path(), info.field("foo").unwrap().type_path());
        assert_eq!(TypeId::of::<i32>(), info.field("foo").unwrap().type_id());
        assert!(info.field("foo").unwrap().type_info().unwrap().is::<i32>());
        assert!(info.field("foo").unwrap().is::<i32>());
        assert_eq!("foo", info.field("foo").unwrap().name());
        assert_eq!(usize::type_path(), info.field_at(1).unwrap().type_path());

        let value: &dyn Reflect = &MyStruct { foo: 123, bar: 321 };
        let info = value.reflect_type_info();
        assert!(info.is::<MyStruct>());

        // Struct (generic)
        #[derive(Reflect)]
        struct MyGenericStruct<T> {
            foo: T,
            bar: usize,
        }

        let info = <MyGenericStruct<i32>>::type_info().as_struct().unwrap();
        assert!(info.is::<MyGenericStruct<i32>>());
        assert_eq!(MyGenericStruct::<i32>::type_path(), info.type_path());
        assert_eq!(i32::type_path(), info.field("foo").unwrap().type_path());
        assert_eq!("foo", info.field("foo").unwrap().name());
        assert!(info.field("foo").unwrap().type_info().unwrap().is::<i32>());
        assert_eq!(usize::type_path(), info.field_at(1).unwrap().type_path());

        let value: &dyn Reflect = &MyGenericStruct {
            foo: String::from("Hello!"),
            bar: 321,
        };
        let info = value.reflect_type_info();
        assert!(info.is::<MyGenericStruct<String>>());

        // Struct (dynamic field)
        #[derive(Reflect)]
        #[reflect(from_reflect = false)]
        struct MyDynamicStruct {
            foo: DynamicStruct,
            bar: usize,
        }

        let info = MyDynamicStruct::type_info();
        if let TypeInfo::Struct(info) = info {
            assert!(info.is::<MyDynamicStruct>());
            assert_eq!(MyDynamicStruct::type_path(), info.type_path());
            assert_eq!(
                DynamicStruct::type_path(),
                info.field("foo").unwrap().type_path()
            );
            assert_eq!("foo", info.field("foo").unwrap().name());
            assert!(info.field("foo").unwrap().type_info().is_none());
            assert_eq!(usize::type_path(), info.field_at(1).unwrap().type_path());
        } else {
            panic!("Expected `TypeInfo::Struct`");
        }

        let value: &dyn Reflect = &MyDynamicStruct {
            foo: DynamicStruct::default(),
            bar: 321,
        };
        let info = value.reflect_type_info();
        assert!(info.is::<MyDynamicStruct>());

        // Tuple Struct
        #[derive(Reflect)]
        struct MyTupleStruct(usize, i32, MyStruct);

        let info = MyTupleStruct::type_info().as_tuple_struct().unwrap();

        assert!(info.is::<MyTupleStruct>());
        assert_eq!(MyTupleStruct::type_path(), info.type_path());
        assert_eq!(i32::type_path(), info.field_at(1).unwrap().type_path());
        assert!(info.field_at(1).unwrap().type_info().unwrap().is::<i32>());
        assert!(info.field_at(1).unwrap().is::<i32>());

        // Tuple
        type MyTuple = (u32, f32, String);

        let info = MyTuple::type_info().as_tuple().unwrap();

        assert!(info.is::<MyTuple>());
        assert_eq!(MyTuple::type_path(), info.type_path());
        assert_eq!(f32::type_path(), info.field_at(1).unwrap().type_path());
        assert!(info.field_at(1).unwrap().type_info().unwrap().is::<f32>());

        let value: &dyn Reflect = &(123_u32, 1.23_f32, String::from("Hello!"));
        let info = value.reflect_type_info();
        assert!(info.is::<MyTuple>());

        // List
        type MyList = Vec<usize>;

        let info = MyList::type_info().as_list().unwrap();

        assert!(info.is::<MyList>());
        assert!(info.item_ty().is::<usize>());
        assert!(info.item_info().unwrap().is::<usize>());
        assert_eq!(MyList::type_path(), info.type_path());
        assert_eq!(usize::type_path(), info.item_ty().path());

        let value: &dyn Reflect = &vec![123_usize];
        let info = value.reflect_type_info();
        assert!(info.is::<MyList>());

        // List (SmallVec)
        #[cfg(feature = "smallvec")]
        {
            type MySmallVec = smallvec::SmallVec<[String; 2]>;

            let info = MySmallVec::type_info().as_list().unwrap();
            assert!(info.is::<MySmallVec>());
            assert!(info.item_ty().is::<String>());
            assert!(info.item_info().unwrap().is::<String>());
            assert_eq!(MySmallVec::type_path(), info.type_path());
            assert_eq!(String::type_path(), info.item_ty().path());

            let value: MySmallVec = smallvec::smallvec![String::default(); 2];
            let value: &dyn Reflect = &value;
            let info = value.reflect_type_info();
            assert!(info.is::<MySmallVec>());
        }

        // Array
        type MyArray = [usize; 3];

        let info = MyArray::type_info().as_array().unwrap();
        assert!(info.is::<MyArray>());
        assert!(info.item_ty().is::<usize>());
        assert!(info.item_info().unwrap().is::<usize>());
        assert_eq!(MyArray::type_path(), info.type_path());
        assert_eq!(usize::type_path(), info.item_ty().path());
        assert_eq!(3, info.capacity());

        let value: &dyn Reflect = &[1usize, 2usize, 3usize];
        let info = value.reflect_type_info();
        assert!(info.is::<MyArray>());

        // Cow<'static, str>
        type MyCowStr = Cow<'static, str>;

        let info = MyCowStr::type_info().as_opaque().unwrap();

        assert!(info.is::<MyCowStr>());
        assert_eq!("alloc::borrow::Cow<str>", info.type_path());

        let value: &dyn Reflect = &Cow::<'static, str>::Owned("Hello!".to_string());
        let info = value.reflect_type_info();
        assert!(info.is::<MyCowStr>());

        // Cow<'static, [u8]>
        type MyCowSlice = Cow<'static, [u8]>;

        let info = MyCowSlice::type_info().as_list().unwrap();

        assert!(info.is::<MyCowSlice>());
        assert!(info.item_ty().is::<u8>());
        assert!(info.item_info().unwrap().is::<u8>());
        assert_eq!("alloc::borrow::Cow<[u8]>", info.type_path());
        assert_eq!("u8", info.item_ty().path());

        let value: &dyn Reflect = &Cow::<'static, [u8]>::Owned(vec![0, 1, 2, 3]);
        let info = value.reflect_type_info();
        assert!(info.is::<MyCowSlice>());

        // Map
        type MyMap = HashMap<usize, f32>;

        let info = MyMap::type_info().as_map().unwrap();

        assert!(info.is::<MyMap>());
        assert!(info.key_ty().is::<usize>());
        assert!(info.value_ty().is::<f32>());
        assert!(info.key_info().unwrap().is::<usize>());
        assert!(info.value_info().unwrap().is::<f32>());
        assert_eq!(MyMap::type_path(), info.type_path());
        assert_eq!(usize::type_path(), info.key_ty().path());
        assert_eq!(f32::type_path(), info.value_ty().path());

        let value: &dyn Reflect = &MyMap::default();
        let info = value.reflect_type_info();
        assert!(info.is::<MyMap>());

        // Map (IndexMap)
        #[cfg(feature = "indexmap")]
        {
            use std::hash::RandomState;

            type MyIndexMap = indexmap::IndexMap<String, u32, RandomState>;

            let info = MyIndexMap::type_info().as_map().unwrap();
            assert!(info.is::<MyIndexMap>());
            assert_eq!(MyIndexMap::type_path(), info.type_path());

            assert!(info.key_ty().is::<String>());
            assert!(info.key_info().unwrap().is::<String>());
            assert_eq!(String::type_path(), info.key_ty().path());

            assert!(info.value_ty().is::<u32>());
            assert!(info.value_info().unwrap().is::<u32>());
            assert_eq!(u32::type_path(), info.value_ty().path());

            let value: MyIndexMap = MyIndexMap::with_capacity_and_hasher(10, RandomState::new());
            let value: &dyn Reflect = &value;
            let info = value.reflect_type_info();
            assert!(info.is::<MyIndexMap>());
        }

        // Value
        type MyValue = String;

        let info = MyValue::type_info().as_opaque().unwrap();

        assert!(info.is::<MyValue>());
        assert_eq!(MyValue::type_path(), info.type_path());

        let value: &dyn Reflect = &String::from("Hello!");
        let info = value.reflect_type_info();
        assert!(info.is::<MyValue>());
    }

    #[test]
    fn get_represented_kind_info() {
        #[derive(Reflect)]
        struct SomeStruct;

        #[derive(Reflect)]
        struct SomeTupleStruct(f32);

        #[derive(Reflect)]
        enum SomeEnum {
            Foo,
            Bar,
        }

        let dyn_struct: &dyn Struct = &SomeStruct;
        let _: &StructInfo = dyn_struct.get_represented_struct_info().unwrap();

        let dyn_map: &dyn Map = &HashMap::<(), ()>::default();
        let _: &MapInfo = dyn_map.get_represented_map_info().unwrap();

        let dyn_array: &dyn Array = &[1, 2, 3];
        let _: &ArrayInfo = dyn_array.get_represented_array_info().unwrap();

        let dyn_list: &dyn List = &vec![1, 2, 3];
        let _: &ListInfo = dyn_list.get_represented_list_info().unwrap();

        let dyn_tuple_struct: &dyn TupleStruct = &SomeTupleStruct(5.0);
        let _: &TupleStructInfo = dyn_tuple_struct
            .get_represented_tuple_struct_info()
            .unwrap();

        let dyn_enum: &dyn Enum = &SomeEnum::Foo;
        let _: &EnumInfo = dyn_enum.get_represented_enum_info().unwrap();
    }

    #[test]
    fn should_permit_higher_ranked_lifetimes() {
        #[derive(Reflect)]
        #[reflect(from_reflect = false)]
        struct TestStruct {
            #[reflect(ignore)]
            _hrl: for<'a> fn(&'a str) -> &'a str,
        }

        impl Default for TestStruct {
            fn default() -> Self {
                TestStruct {
                    _hrl: |input| input,
                }
            }
        }

        fn get_type_registration<T: GetTypeRegistration>() {}
        get_type_registration::<TestStruct>();
    }

    #[test]
    fn should_permit_valid_represented_type_for_dynamic() {
        let type_info = <[i32; 2] as Typed>::type_info();
        let mut dynamic_array = [123; 2].to_dynamic_array();
        dynamic_array.set_represented_type(Some(type_info));
    }

    #[test]
    #[should_panic(expected = "expected TypeInfo::Array but received")]
    fn should_prohibit_invalid_represented_type_for_dynamic() {
        let type_info = <(i32, i32) as Typed>::type_info();
        let mut dynamic_array = [123; 2].to_dynamic_array();
        dynamic_array.set_represented_type(Some(type_info));
    }

    #[cfg(feature = "reflect_documentation")]
    mod docstrings {
        use super::*;

        #[test]
        fn should_not_contain_docs() {
            // Regular comments do not count as doc comments,
            // and are therefore not reflected.
            #[derive(Reflect)]
            struct SomeStruct;

            let info = <SomeStruct as Typed>::type_info();
            assert_eq!(None, info.docs());

            // Block comments do not count as doc comments,
            // and are therefore not reflected.
            #[derive(Reflect)]
            struct SomeOtherStruct;

            let info = <SomeOtherStruct as Typed>::type_info();
            assert_eq!(None, info.docs());
        }

        #[test]
        fn should_contain_docs() {
            /// Some struct.
            ///
            /// # Example
            ///
            /// ```ignore (This is only used for a unit test, no need to doc test)
            /// let some_struct = SomeStruct;
            /// ```
            #[derive(Reflect)]
            struct SomeStruct;

            let info = <SomeStruct as Typed>::type_info();
            assert_eq!(
                Some(" Some struct.\n\n # Example\n\n ```ignore (This is only used for a unit test, no need to doc test)\n let some_struct = SomeStruct;\n ```"),
                info.docs()
            );

            #[doc = "The compiler automatically converts `///`-style comments into `#[doc]` attributes."]
            #[doc = "Of course, you _could_ use the attribute directly if you wanted to."]
            #[doc = "Both will be reflected."]
            #[derive(Reflect)]
            struct SomeOtherStruct;

            let info = <SomeOtherStruct as Typed>::type_info();
            assert_eq!(
                Some("The compiler automatically converts `///`-style comments into `#[doc]` attributes.\nOf course, you _could_ use the attribute directly if you wanted to.\nBoth will be reflected."),
                info.docs()
            );

            /// Some tuple struct.
            #[derive(Reflect)]
            struct SomeTupleStruct(usize);

            let info = <SomeTupleStruct as Typed>::type_info();
            assert_eq!(Some(" Some tuple struct."), info.docs());

            /// Some enum.
            #[derive(Reflect)]
            enum SomeEnum {
                Foo,
            }

            let info = <SomeEnum as Typed>::type_info();
            assert_eq!(Some(" Some enum."), info.docs());

            #[derive(Clone)]
            struct SomePrimitive;
            impl_reflect_opaque!(
                /// Some primitive for which we have attributed custom documentation.
                (in bevy_reflect::tests) SomePrimitive
            );

            let info = <SomePrimitive as Typed>::type_info();
            assert_eq!(
                Some(" Some primitive for which we have attributed custom documentation."),
                info.docs()
            );
        }

        #[test]
        fn fields_should_contain_docs() {
            #[derive(Reflect)]
            struct SomeStruct {
                /// The name
                name: String,
                /// The index
                index: usize,
                // Not documented...
                data: Vec<i32>,
            }

            let info = <SomeStruct as Typed>::type_info().as_struct().unwrap();

            let mut fields = info.iter();
            assert_eq!(Some(" The name"), fields.next().unwrap().docs());
            assert_eq!(Some(" The index"), fields.next().unwrap().docs());
            assert_eq!(None, fields.next().unwrap().docs());
        }

        #[test]
        fn variants_should_contain_docs() {
            #[derive(Reflect)]
            enum SomeEnum {
                // Not documented...
                Nothing,
                /// Option A
                A(
                    /// Index
                    usize,
                ),
                /// Option B
                B {
                    /// Name
                    name: String,
                },
            }

            let info = <SomeEnum as Typed>::type_info().as_enum().unwrap();

            let mut variants = info.iter();
            assert_eq!(None, variants.next().unwrap().docs());

            let variant = variants.next().unwrap().as_tuple_variant().unwrap();
            assert_eq!(Some(" Option A"), variant.docs());
            let field = variant.field_at(0).unwrap();
            assert_eq!(Some(" Index"), field.docs());

            let variant = variants.next().unwrap().as_struct_variant().unwrap();
            assert_eq!(Some(" Option B"), variant.docs());
            let field = variant.field_at(0).unwrap();
            assert_eq!(Some(" Name"), field.docs());
        }
    }

    #[test]
    fn into_reflect() {
        trait TestTrait: Reflect {}

        #[derive(Reflect)]
        struct TestStruct;

        impl TestTrait for TestStruct {}

        let trait_object: Box<dyn TestTrait> = Box::new(TestStruct);

        // Should compile:
        let _ = trait_object.into_reflect();
    }

    #[test]
    fn as_reflect() {
        trait TestTrait: Reflect {}

        #[derive(Reflect)]
        struct TestStruct;

        impl TestTrait for TestStruct {}

        let trait_object: Box<dyn TestTrait> = Box::new(TestStruct);

        // Should compile:
        let _ = trait_object.as_reflect();
    }

    #[test]
    fn should_reflect_debug() {
        #[derive(Reflect)]
        struct Test {
            value: usize,
            list: Vec<String>,
            array: [f32; 3],
            map: HashMap<i32, f32>,
            a_struct: SomeStruct,
            a_tuple_struct: SomeTupleStruct,
            enum_unit: SomeEnum,
            enum_tuple: SomeEnum,
            enum_struct: SomeEnum,
            custom: CustomDebug,
            #[reflect(ignore)]
            #[expect(dead_code, reason = "This value is intended to not be reflected.")]
            ignored: isize,
        }

        #[derive(Reflect)]
        struct SomeStruct {
            foo: String,
        }

        #[derive(Reflect)]
        enum SomeEnum {
            A,
            B(usize),
            C { value: i32 },
        }

        #[derive(Reflect)]
        struct SomeTupleStruct(String);

        #[derive(Reflect)]
        #[reflect(Debug)]
        struct CustomDebug;
        impl Debug for CustomDebug {
            fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
                f.write_str("Cool debug!")
            }
        }

        let mut map = <HashMap<_, _>>::default();
        map.insert(123, 1.23);

        let test = Test {
            value: 123,
            list: vec![String::from("A"), String::from("B"), String::from("C")],
            array: [1.0, 2.0, 3.0],
            map,
            a_struct: SomeStruct {
                foo: String::from("A Struct!"),
            },
            a_tuple_struct: SomeTupleStruct(String::from("A Tuple Struct!")),
            enum_unit: SomeEnum::A,
            enum_tuple: SomeEnum::B(123),
            enum_struct: SomeEnum::C { value: 321 },
            custom: CustomDebug,
            ignored: 321,
        };

        let reflected: &dyn Reflect = &test;
        let expected = r#"
bevy_reflect::tests::Test {
    value: 123,
    list: [
        "A",
        "B",
        "C",
    ],
    array: [
        1.0,
        2.0,
        3.0,
    ],
    map: {
        123: 1.23,
    },
    a_struct: bevy_reflect::tests::SomeStruct {
        foo: "A Struct!",
    },
    a_tuple_struct: bevy_reflect::tests::SomeTupleStruct(
        "A Tuple Struct!",
    ),
    enum_unit: A,
    enum_tuple: B(
        123,
    ),
    enum_struct: C {
        value: 321,
    },
    custom: Cool debug!,
}"#;

        assert_eq!(expected, format!("\n{reflected:#?}"));
    }

    #[test]
    fn multiple_reflect_lists() {
        #[derive(Hash, PartialEq, Reflect)]
        #[reflect(Debug, Hash)]
        #[reflect(PartialEq)]
        struct Foo(i32);

        impl Debug for Foo {
            fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
                write!(f, "Foo")
            }
        }

        let foo = Foo(123);
        let foo: &dyn PartialReflect = &foo;

        assert!(foo.reflect_hash().is_some());
        assert_eq!(Some(true), foo.reflect_partial_eq(foo));
        assert_eq!("Foo".to_string(), format!("{foo:?}"));
    }

    #[test]
    fn custom_debug_function() {
        #[derive(Reflect)]
        #[reflect(Debug(custom_debug))]
        struct Foo {
            a: u32,
        }

        fn custom_debug(_x: &Foo, f: &mut Formatter<'_>) -> core::fmt::Result {
            write!(f, "123")
        }

        let foo = Foo { a: 1 };
        let foo: &dyn Reflect = &foo;

        assert_eq!("123", format!("{foo:?}"));
    }

    #[test]
    fn should_allow_custom_where() {
        #[derive(Reflect)]
        #[reflect(where T: Default)]
        struct Foo<T>(String, #[reflect(ignore)] PhantomData<T>);

        #[derive(Default, TypePath)]
        struct Bar;

        #[derive(TypePath)]
        struct Baz;

        assert_impl_all!(Foo<Bar>: Reflect);
        assert_not_impl_all!(Foo<Baz>: Reflect);
    }

    #[test]
    fn should_allow_empty_custom_where() {
        #[derive(Reflect)]
        #[reflect(where)]
        struct Foo<T>(String, #[reflect(ignore)] PhantomData<T>);

        #[derive(TypePath)]
        struct Bar;

        assert_impl_all!(Foo<Bar>: Reflect);
    }

    #[test]
    fn should_allow_multiple_custom_where() {
        #[derive(Reflect)]
        #[reflect(where T: Default)]
        #[reflect(where U: core::ops::Add<T>)]
        struct Foo<T, U>(T, U);

        #[allow(
            clippy::allow_attributes,
            dead_code,
            reason = "This struct is used as a compilation test to test the derive macros, and as such is intentionally never constructed."
        )]
        #[derive(Reflect)]
        struct Baz {
            a: Foo<i32, i32>,
            b: Foo<u32, u32>,
        }

        assert_impl_all!(Foo<i32, i32>: Reflect);
        assert_not_impl_all!(Foo<i32, usize>: Reflect);
    }

    #[test]
    fn should_allow_custom_where_with_assoc_type() {
        trait Trait {
            type Assoc;
        }

        // We don't need `T` to be `Reflect` since we only care about `T::Assoc`
        #[derive(Reflect)]
        #[reflect(where T::Assoc: core::fmt::Display)]
        struct Foo<T: Trait>(T::Assoc);

        #[derive(TypePath)]
        struct Bar;

        impl Trait for Bar {
            type Assoc = usize;
        }

        #[derive(TypePath)]
        struct Baz;

        impl Trait for Baz {
            type Assoc = (f32, f32);
        }

        assert_impl_all!(Foo<Bar>: Reflect);
        assert_not_impl_all!(Foo<Baz>: Reflect);
    }

    #[test]
    fn should_allow_empty_enums() {
        #[derive(Reflect)]
        enum Empty {}

        assert_impl_all!(Empty: Reflect);
    }

    #[test]
    fn recursive_typed_storage_does_not_hang() {
        #[derive(Reflect)]
        struct Recurse<T>(T);

        let _ = <Recurse<Recurse<()>> as Typed>::type_info();
        let _ = <Recurse<Recurse<()>> as TypePath>::type_path();

        #[derive(Reflect)]
        #[reflect(no_field_bounds)]
        struct SelfRecurse {
            recurse: Vec<SelfRecurse>,
        }

        let _ = <SelfRecurse as Typed>::type_info();
        let _ = <SelfRecurse as TypePath>::type_path();

        #[derive(Reflect)]
        #[reflect(no_field_bounds)]
        enum RecurseA {
            Recurse(RecurseB),
        }

        #[derive(Reflect)]
        // `#[reflect(no_field_bounds)]` not needed since already added to `RecurseA`
        struct RecurseB {
            vector: Vec<RecurseA>,
        }

        let _ = <RecurseA as Typed>::type_info();
        let _ = <RecurseA as TypePath>::type_path();
        let _ = <RecurseB as Typed>::type_info();
        let _ = <RecurseB as TypePath>::type_path();
    }

    #[test]
    fn recursive_registration_does_not_hang() {
        #[derive(Reflect)]
        struct Recurse<T>(T);

        let mut registry = TypeRegistry::empty();

        registry.register::<Recurse<Recurse<()>>>();

        #[derive(Reflect)]
        #[reflect(no_field_bounds)]
        struct SelfRecurse {
            recurse: Vec<SelfRecurse>,
        }

        registry.register::<SelfRecurse>();

        #[derive(Reflect)]
        #[reflect(no_field_bounds)]
        enum RecurseA {
            Recurse(RecurseB),
        }

        #[derive(Reflect)]
        struct RecurseB {
            vector: Vec<RecurseA>,
        }

        registry.register::<RecurseA>();
        assert!(registry.contains(TypeId::of::<RecurseA>()));
        assert!(registry.contains(TypeId::of::<RecurseB>()));
    }

    #[test]
    fn can_opt_out_type_path() {
        #[derive(Reflect)]
        #[reflect(type_path = false)]
        struct Foo<T> {
            #[reflect(ignore)]
            _marker: PhantomData<T>,
        }

        struct NotTypePath;

        impl<T: 'static> TypePath for Foo<T> {
            fn type_path() -> &'static str {
                core::any::type_name::<Self>()
            }

            fn short_type_path() -> &'static str {
                static CELL: GenericTypePathCell = GenericTypePathCell::new();
                CELL.get_or_insert::<Self, _>(|| ShortName::of::<Self>().to_string())
            }

            fn type_ident() -> Option<&'static str> {
                Some("Foo")
            }

            fn crate_name() -> Option<&'static str> {
                Some("bevy_reflect")
            }

            fn module_path() -> Option<&'static str> {
                Some("bevy_reflect::tests")
            }
        }

        // Can use `TypePath`
        let path = <Foo<NotTypePath> as TypePath>::type_path();
        assert_eq!("bevy_reflect::tests::can_opt_out_type_path::Foo<bevy_reflect::tests::can_opt_out_type_path::NotTypePath>", path);

        // Can register the type
        let mut registry = TypeRegistry::default();
        registry.register::<Foo<NotTypePath>>();

        let registration = registry.get(TypeId::of::<Foo<NotTypePath>>()).unwrap();
        assert_eq!(
            "Foo<NotTypePath>",
            registration.type_info().type_path_table().short_path()
        );
    }

    #[test]
    fn dynamic_types_debug_format() {
        #[derive(Debug, Reflect)]
        struct TestTupleStruct(u32);

        #[derive(Debug, Reflect)]
        enum TestEnum {
            A(u32),
            B,
        }

        #[derive(Debug, Reflect)]
        // test DynamicStruct
        struct TestStruct {
            // test DynamicTuple
            tuple: (u32, u32),
            // test DynamicTupleStruct
            tuple_struct: TestTupleStruct,
            // test DynamicList
            list: Vec<u32>,
            // test DynamicArray
            array: [u32; 3],
            // test DynamicEnum
            e: TestEnum,
            // test DynamicMap
            map: HashMap<u32, u32>,
            // test reflected value
            value: u32,
        }
        let mut map = <HashMap<_, _>>::default();
        map.insert(9, 10);
        let mut test_struct: DynamicStruct = TestStruct {
            tuple: (0, 1),
            list: vec![2, 3, 4],
            array: [5, 6, 7],
            tuple_struct: TestTupleStruct(8),
            e: TestEnum::A(11),
            map,
            value: 12,
        }
        .to_dynamic_struct();

        // test unknown DynamicStruct
        let mut test_unknown_struct = DynamicStruct::default();
        test_unknown_struct.insert("a", 13);
        test_struct.insert("unknown_struct", test_unknown_struct);
        // test unknown DynamicTupleStruct
        let mut test_unknown_tuple_struct = DynamicTupleStruct::default();
        test_unknown_tuple_struct.insert(14);
        test_struct.insert("unknown_tuplestruct", test_unknown_tuple_struct);
        assert_eq!(
            format!("{test_struct:?}"),
            "DynamicStruct(bevy_reflect::tests::TestStruct { \
                tuple: DynamicTuple((0, 1)), \
                tuple_struct: DynamicTupleStruct(bevy_reflect::tests::TestTupleStruct(8)), \
                list: DynamicList([2, 3, 4]), \
                array: DynamicArray([5, 6, 7]), \
                e: DynamicEnum(A(11)), \
                map: DynamicMap({9: 10}), \
                value: 12, \
                unknown_struct: DynamicStruct(_ { a: 13 }), \
                unknown_tuplestruct: DynamicTupleStruct(_(14)) \
            })"
        );
    }

    #[test]
    fn assert_impl_reflect_macro_on_all() {
        struct Struct {
            foo: (),
        }
        struct TupleStruct(());
        enum Enum {
            Foo { foo: () },
            Bar(()),
        }

        impl_reflect!(
            #[type_path = "my_crate::foo"]
            struct Struct {
                foo: (),
            }
        );

        impl_reflect!(
            #[type_path = "my_crate::foo"]
            struct TupleStruct(());
        );

        impl_reflect!(
            #[type_path = "my_crate::foo"]
            enum Enum {
                Foo { foo: () },
                Bar(()),
            }
        );

        assert_impl_all!(Struct: Reflect);
        assert_impl_all!(TupleStruct: Reflect);
        assert_impl_all!(Enum: Reflect);
    }

    #[test]
    fn should_reflect_remote_type() {
        mod external_crate {
            use alloc::string::String;

            #[derive(Debug, Default)]
            pub struct TheirType {
                pub value: String,
            }
        }

        // === Remote Wrapper === //
        #[reflect_remote(external_crate::TheirType)]
        #[derive(Debug, Default)]
        #[reflect(Debug, Default)]
        struct MyType {
            pub value: String,
        }

        let mut patch = DynamicStruct::default();
        patch.set_represented_type(Some(MyType::type_info()));
        patch.insert("value", "Goodbye".to_string());

        let mut data = MyType(external_crate::TheirType {
            value: "Hello".to_string(),
        });

        assert_eq!("Hello", data.0.value);
        data.apply(&patch);
        assert_eq!("Goodbye", data.0.value);

        // === Struct Container === //
        #[derive(Reflect, Debug)]
        #[reflect(from_reflect = false)]
        struct ContainerStruct {
            #[reflect(remote = MyType)]
            their_type: external_crate::TheirType,
        }

        let mut patch = DynamicStruct::default();
        patch.set_represented_type(Some(ContainerStruct::type_info()));
        patch.insert(
            "their_type",
            MyType(external_crate::TheirType {
                value: "Goodbye".to_string(),
            }),
        );

        let mut data = ContainerStruct {
            their_type: external_crate::TheirType {
                value: "Hello".to_string(),
            },
        };

        assert_eq!("Hello", data.their_type.value);
        data.apply(&patch);
        assert_eq!("Goodbye", data.their_type.value);

        // === Tuple Struct Container === //
        #[derive(Reflect, Debug)]
        struct ContainerTupleStruct(#[reflect(remote = MyType)] external_crate::TheirType);

        let mut patch = DynamicTupleStruct::default();
        patch.set_represented_type(Some(ContainerTupleStruct::type_info()));
        patch.insert(MyType(external_crate::TheirType {
            value: "Goodbye".to_string(),
        }));

        let mut data = ContainerTupleStruct(external_crate::TheirType {
            value: "Hello".to_string(),
        });

        assert_eq!("Hello", data.0.value);
        data.apply(&patch);
        assert_eq!("Goodbye", data.0.value);
    }

    #[test]
    fn should_reflect_remote_value_type() {
        mod external_crate {
            use alloc::string::String;

            #[derive(Clone, Debug, Default)]
            pub struct TheirType {
                pub value: String,
            }
        }

        // === Remote Wrapper === //
        #[reflect_remote(external_crate::TheirType)]
        #[derive(Clone, Debug, Default)]
        #[reflect(opaque)]
        #[reflect(Debug, Default)]
        struct MyType {
            pub value: String,
        }

        let mut data = MyType(external_crate::TheirType {
            value: "Hello".to_string(),
        });

        let patch = MyType(external_crate::TheirType {
            value: "Goodbye".to_string(),
        });

        assert_eq!("Hello", data.0.value);
        data.apply(&patch);
        assert_eq!("Goodbye", data.0.value);

        // === Struct Container === //
        #[derive(Reflect, Debug)]
        #[reflect(from_reflect = false)]
        struct ContainerStruct {
            #[reflect(remote = MyType)]
            their_type: external_crate::TheirType,
        }

        let mut patch = DynamicStruct::default();
        patch.set_represented_type(Some(ContainerStruct::type_info()));
        patch.insert(
            "their_type",
            MyType(external_crate::TheirType {
                value: "Goodbye".to_string(),
            }),
        );

        let mut data = ContainerStruct {
            their_type: external_crate::TheirType {
                value: "Hello".to_string(),
            },
        };

        assert_eq!("Hello", data.their_type.value);
        data.apply(&patch);
        assert_eq!("Goodbye", data.their_type.value);

        // === Tuple Struct Container === //
        #[derive(Reflect, Debug)]
        struct ContainerTupleStruct(#[reflect(remote = MyType)] external_crate::TheirType);

        let mut patch = DynamicTupleStruct::default();
        patch.set_represented_type(Some(ContainerTupleStruct::type_info()));
        patch.insert(MyType(external_crate::TheirType {
            value: "Goodbye".to_string(),
        }));

        let mut data = ContainerTupleStruct(external_crate::TheirType {
            value: "Hello".to_string(),
        });

        assert_eq!("Hello", data.0.value);
        data.apply(&patch);
        assert_eq!("Goodbye", data.0.value);
    }

    #[test]
    fn should_reflect_remote_type_from_module() {
        mod wrapper {
            use super::*;

            // We have to place this module internally to this one to get around the following error:
            // ```
            // error[E0433]: failed to resolve: use of undeclared crate or module `external_crate`
            // ```
            pub mod external_crate {
                use alloc::string::String;

                #[allow(
                    clippy::allow_attributes,
                    dead_code,
                    reason = "This struct is used as a compilation test to test the derive macros, and as such is intentionally never constructed."
                )]
                pub struct TheirType {
                    pub value: String,
                }
            }

            #[reflect_remote(external_crate::TheirType)]
            pub struct MyType {
                pub value: String,
            }
        }

        #[allow(
            clippy::allow_attributes,
            dead_code,
            reason = "This struct is used as a compilation test to test the derive macros, and as such is intentionally never constructed."
        )]
        #[derive(Reflect)]
        struct ContainerStruct {
            #[reflect(remote = wrapper::MyType)]
            their_type: wrapper::external_crate::TheirType,
        }
    }

    #[test]
    fn should_reflect_remote_enum() {
        mod external_crate {
            use alloc::string::String;

            #[derive(Debug, PartialEq, Eq)]
            pub enum TheirType {
                Unit,
                Tuple(usize),
                Struct { value: String },
            }
        }

        // === Remote Wrapper === //
        #[reflect_remote(external_crate::TheirType)]
        #[derive(Debug)]
        #[reflect(Debug)]
        enum MyType {
            Unit,
            Tuple(usize),
            Struct { value: String },
        }

        let mut patch = DynamicEnum::from(MyType(external_crate::TheirType::Tuple(123)));

        let mut data = MyType(external_crate::TheirType::Unit);

        assert_eq!(external_crate::TheirType::Unit, data.0);
        data.apply(&patch);
        assert_eq!(external_crate::TheirType::Tuple(123), data.0);

        patch = DynamicEnum::from(MyType(external_crate::TheirType::Struct {
            value: "Hello world!".to_string(),
        }));

        data.apply(&patch);
        assert_eq!(
            external_crate::TheirType::Struct {
                value: "Hello world!".to_string()
            },
            data.0
        );

        // === Enum Container === //
        #[derive(Reflect, Debug, PartialEq)]
        enum ContainerEnum {
            Foo,
            Bar {
                #[reflect(remote = MyType)]
                their_type: external_crate::TheirType,
            },
        }

        let patch = DynamicEnum::from(ContainerEnum::Bar {
            their_type: external_crate::TheirType::Tuple(123),
        });

        let mut data = ContainerEnum::Foo;

        assert_eq!(ContainerEnum::Foo, data);
        data.apply(&patch);
        assert_eq!(
            ContainerEnum::Bar {
                their_type: external_crate::TheirType::Tuple(123)
            },
            data
        );
    }

    #[test]
    fn should_reflect_nested_remote_type() {
        mod external_crate {
            pub struct TheirOuter<T> {
                pub a: TheirInner<T>,
                pub b: TheirInner<bool>,
            }

            pub struct TheirInner<T>(pub T);
        }

        #[reflect_remote(external_crate::TheirOuter<T>)]
        struct MyOuter<T: FromReflect + Reflectable> {
            #[reflect(remote = MyInner<T>)]
            pub a: external_crate::TheirInner<T>,
            #[reflect(remote = MyInner<bool>)]
            pub b: external_crate::TheirInner<bool>,
        }

        #[reflect_remote(external_crate::TheirInner<T>)]
        struct MyInner<T: FromReflect>(pub T);

        let mut patch = DynamicStruct::default();
        patch.set_represented_type(Some(MyOuter::<i32>::type_info()));
        patch.insert("a", MyInner(external_crate::TheirInner(321_i32)));
        patch.insert("b", MyInner(external_crate::TheirInner(true)));

        let mut data = MyOuter(external_crate::TheirOuter {
            a: external_crate::TheirInner(123_i32),
            b: external_crate::TheirInner(false),
        });

        assert_eq!(123, data.0.a.0);
        assert!(!data.0.b.0);
        data.apply(&patch);
        assert_eq!(321, data.0.a.0);
        assert!(data.0.b.0);
    }

    #[test]
    fn should_reflect_nested_remote_enum() {
        mod external_crate {
            use core::fmt::Debug;

            #[derive(Debug)]
            pub enum TheirOuter<T: Debug> {
                Unit,
                Tuple(TheirInner<T>),
                Struct { value: TheirInner<T> },
            }
            #[derive(Debug)]
            pub enum TheirInner<T: Debug> {
                Unit,
                Tuple(T),
                Struct { value: T },
            }
        }

        #[reflect_remote(external_crate::TheirOuter<T>)]
        #[derive(Debug)]
        enum MyOuter<T: FromReflect + Reflectable + Debug> {
            Unit,
            Tuple(#[reflect(remote = MyInner<T>)] external_crate::TheirInner<T>),
            Struct {
                #[reflect(remote = MyInner<T>)]
                value: external_crate::TheirInner<T>,
            },
        }

        #[reflect_remote(external_crate::TheirInner<T>)]
        #[derive(Debug)]
        enum MyInner<T: FromReflect + Debug> {
            Unit,
            Tuple(T),
            Struct { value: T },
        }

        let mut patch = DynamicEnum::default();
        let mut value = DynamicStruct::default();
        value.insert("value", MyInner(external_crate::TheirInner::Tuple(123)));
        patch.set_variant("Struct", value);

        let mut data = MyOuter(external_crate::TheirOuter::<i32>::Unit);

        assert!(matches!(
            data,
            MyOuter(external_crate::TheirOuter::<i32>::Unit)
        ));
        data.apply(&patch);
        assert!(matches!(
            data,
            MyOuter(external_crate::TheirOuter::Struct {
                value: external_crate::TheirInner::Tuple(123)
            })
        ));
    }

    #[test]
    fn should_take_remote_type() {
        mod external_crate {
            use alloc::string::String;

            #[derive(Debug, Default, PartialEq, Eq)]
            pub struct TheirType {
                pub value: String,
            }
        }

        // === Remote Wrapper === //
        #[reflect_remote(external_crate::TheirType)]
        #[derive(Debug, Default)]
        #[reflect(Debug, Default)]
        struct MyType {
            pub value: String,
        }

        let input: Box<dyn Reflect> = Box::new(MyType(external_crate::TheirType {
            value: "Hello".to_string(),
        }));

        let output: external_crate::TheirType = input
            .take()
            .expect("should downcast to `external_crate::TheirType`");
        assert_eq!(
            external_crate::TheirType {
                value: "Hello".to_string(),
            },
            output
        );
    }

    #[test]
    fn should_try_take_remote_type() {
        mod external_crate {
            use alloc::string::String;

            #[derive(Debug, Default, PartialEq, Eq)]
            pub struct TheirType {
                pub value: String,
            }
        }

        // === Remote Wrapper === //
        #[reflect_remote(external_crate::TheirType)]
        #[derive(Debug, Default)]
        #[reflect(Debug, Default)]
        struct MyType {
            pub value: String,
        }

        let input: Box<dyn PartialReflect> = Box::new(MyType(external_crate::TheirType {
            value: "Hello".to_string(),
        }));

        let output: external_crate::TheirType = input
            .try_take()
            .expect("should downcast to `external_crate::TheirType`");
        assert_eq!(
            external_crate::TheirType {
                value: "Hello".to_string(),
            },
            output,
        );
    }

    #[test]
    fn should_take_nested_remote_type() {
        mod external_crate {
            #[derive(PartialEq, Eq, Debug)]
            pub struct TheirOuter<T> {
                pub inner: TheirInner<T>,
            }
            #[derive(PartialEq, Eq, Debug)]
            pub struct TheirInner<T>(pub T);
        }

        #[reflect_remote(external_crate::TheirOuter<T>)]
        struct MyOuter<T: FromReflect + Reflectable> {
            #[reflect(remote = MyInner<T>)]
            pub inner: external_crate::TheirInner<T>,
        }

        #[reflect_remote(external_crate::TheirInner<T>)]
        struct MyInner<T: FromReflect>(pub T);

        let input: Box<dyn Reflect> = Box::new(MyOuter(external_crate::TheirOuter {
            inner: external_crate::TheirInner(123),
        }));

        let output: external_crate::TheirOuter<i32> = input
            .take()
            .expect("should downcast to `external_crate::TheirOuter`");
        assert_eq!(
            external_crate::TheirOuter {
                inner: external_crate::TheirInner(123),
            },
            output
        );
    }

    // https://github.com/bevyengine/bevy/issues/19017
    #[test]
    fn should_serialize_opaque_remote_type() {
        mod external_crate {
            use serde::{Deserialize, Serialize};
            #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
            pub struct Vector2<T>(pub [T; 2]);
        }

        #[reflect_remote(external_crate::Vector2<i32>)]
        #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
        #[reflect(Serialize, Deserialize)]
        #[reflect(opaque)]
        struct Vector2Wrapper([i32; 2]);

        #[derive(Reflect, Debug, PartialEq)]
        struct Point(#[reflect(remote = Vector2Wrapper)] external_crate::Vector2<i32>);

        let point = Point(external_crate::Vector2([1, 2]));

        let mut registry = TypeRegistry::new();
        registry.register::<Point>();
        registry.register::<Vector2Wrapper>();

        let serializer = ReflectSerializer::new(&point, &registry);
        let serialized = ron::to_string(&serializer).unwrap();
        assert_eq!(serialized, r#"{"bevy_reflect::tests::Point":((((1,2))))}"#);

        let mut deserializer = Deserializer::from_str(&serialized).unwrap();
        let reflect_deserializer = ReflectDeserializer::new(&registry);
        let deserialized = reflect_deserializer.deserialize(&mut deserializer).unwrap();
        let point = <Point as FromReflect>::from_reflect(&*deserialized).unwrap();
        assert_eq!(point, Point(external_crate::Vector2([1, 2])));
    }

    #[cfg(feature = "auto_register")]
    mod auto_register_reflect {
        use super::*;

        #[test]
        fn should_ignore_auto_reflect_registration() {
            #[derive(Reflect)]
            #[reflect(no_auto_register)]
            struct NoAutomaticStruct {
                a: usize,
            }

            let mut registry = TypeRegistry::default();
            registry.register_derived_types();

            assert!(!registry.contains(TypeId::of::<NoAutomaticStruct>()));
        }

        #[test]
        fn should_auto_register_reflect_for_all_supported_types() {
            // Struct
            #[derive(Reflect)]
            struct StructReflect {
                a: usize,
            }

            // ZST struct
            #[derive(Reflect)]
            struct ZSTStructReflect;

            // Tuple struct
            #[derive(Reflect)]
            struct TupleStructReflect(pub u32);

            // Enum
            #[derive(Reflect)]
            enum EnumReflect {
                A,
                B,
            }

            // ZST enum
            #[derive(Reflect)]
            enum ZSTEnumReflect {}

            // Opaque struct
            #[derive(Reflect, Clone)]
            #[reflect(opaque)]
            struct OpaqueStructReflect {
                _a: usize,
            }

            // ZST opaque struct
            #[derive(Reflect, Clone)]
            #[reflect(opaque)]
            struct ZSTOpaqueStructReflect;

            let mut registry = TypeRegistry::default();
            registry.register_derived_types();

            assert!(registry.contains(TypeId::of::<StructReflect>()));
            assert!(registry.contains(TypeId::of::<ZSTStructReflect>()));
            assert!(registry.contains(TypeId::of::<TupleStructReflect>()));
            assert!(registry.contains(TypeId::of::<EnumReflect>()));
            assert!(registry.contains(TypeId::of::<ZSTEnumReflect>()));
            assert!(registry.contains(TypeId::of::<OpaqueStructReflect>()));
            assert!(registry.contains(TypeId::of::<ZSTOpaqueStructReflect>()));
        }

        #[test]
        fn type_data_dependency() {
            #[derive(Reflect)]
            #[reflect(A)]
            struct X;

            #[derive(Clone)]
            struct ReflectA;

            impl<T> FromType<T> for ReflectA {
                fn from_type() -> Self {
                    ReflectA
                }

                fn insert_dependencies(type_registration: &mut TypeRegistration) {
                    type_registration.insert(ReflectB);
                }
            }

            #[derive(Clone)]
            struct ReflectB;

            let mut registry = TypeRegistry::new();
            registry.register::<X>();

            let registration = registry.get(TypeId::of::<X>()).unwrap();
            assert!(registration.data::<ReflectA>().is_some());
            assert!(registration.data::<ReflectB>().is_some());
        }
    }

    #[cfg(feature = "glam")]
    mod glam {
        use super::*;
        use ::glam::{quat, vec3, Quat, Vec3};

        #[test]
        fn quat_serialization() {
            let q = quat(1.0, 2.0, 3.0, 4.0);

            let mut registry = TypeRegistry::default();
            registry.register::<f32>();
            registry.register::<Quat>();

            let ser = ReflectSerializer::new(&q, &registry);

            let config = PrettyConfig::default()
                .new_line(String::from("\n"))
                .indentor(String::from("    "));
            let output = to_string_pretty(&ser, config).unwrap();
            let expected = r#"
{
    "glam::Quat": (1.0, 2.0, 3.0, 4.0),
}"#;

            assert_eq!(expected, format!("\n{output}"));
        }

        #[test]
        fn quat_deserialization() {
            let data = r#"
{
    "glam::Quat": (1.0, 2.0, 3.0, 4.0),
}"#;

            let mut registry = TypeRegistry::default();
            registry.register::<Quat>();
            registry.register::<f32>();

            let de = ReflectDeserializer::new(&registry);

            let mut deserializer =
                Deserializer::from_str(data).expect("Failed to acquire deserializer");

            let dynamic_struct = de
                .deserialize(&mut deserializer)
                .expect("Failed to deserialize");

            let mut result = Quat::default();

            result.apply(dynamic_struct.as_partial_reflect());

            assert_eq!(result, quat(1.0, 2.0, 3.0, 4.0));
        }

        #[test]
        fn vec3_serialization() {
            let v = vec3(12.0, 3.0, -6.9);

            let mut registry = TypeRegistry::default();
            registry.register::<f32>();
            registry.register::<Vec3>();

            let ser = ReflectSerializer::new(&v, &registry);

            let config = PrettyConfig::default()
                .new_line(String::from("\n"))
                .indentor(String::from("    "));
            let output = to_string_pretty(&ser, config).unwrap();
            let expected = r#"
{
    "glam::Vec3": (12.0, 3.0, -6.9),
}"#;

            assert_eq!(expected, format!("\n{output}"));
        }

        #[test]
        fn vec3_deserialization() {
            let data = r#"
{
    "glam::Vec3": (12.0, 3.0, -6.9),
}"#;

            let mut registry = TypeRegistry::default();
            registry.add_registration(Vec3::get_type_registration());
            registry.add_registration(f32::get_type_registration());

            let de = ReflectDeserializer::new(&registry);

            let mut deserializer =
                Deserializer::from_str(data).expect("Failed to acquire deserializer");

            let dynamic_struct = de
                .deserialize(&mut deserializer)
                .expect("Failed to deserialize");

            let mut result = Vec3::default();

            result.apply(dynamic_struct.as_partial_reflect());

            assert_eq!(result, vec3(12.0, 3.0, -6.9));
        }

        #[test]
        fn vec3_field_access() {
            let mut v = vec3(1.0, 2.0, 3.0);

            assert_eq!(*v.get_field::<f32>("x").unwrap(), 1.0);

            *v.get_field_mut::<f32>("y").unwrap() = 6.0;

            assert_eq!(v.y, 6.0);
        }

        #[test]
        fn vec3_path_access() {
            let mut v = vec3(1.0, 2.0, 3.0);

            assert_eq!(
                *v.reflect_path("x")
                    .unwrap()
                    .try_downcast_ref::<f32>()
                    .unwrap(),
                1.0
            );

            *v.reflect_path_mut("y")
                .unwrap()
                .try_downcast_mut::<f32>()
                .unwrap() = 6.0;

            assert_eq!(v.y, 6.0);
        }

        #[test]
        fn vec3_apply_dynamic() {
            let mut v = vec3(3.0, 3.0, 3.0);

            let mut d = DynamicStruct::default();
            d.insert("x", 4.0f32);
            d.insert("y", 2.0f32);
            d.insert("z", 1.0f32);

            v.apply(&d);

            assert_eq!(v, vec3(4.0, 2.0, 1.0));
        }
    }
}