bevy/crates/bevy_reflect/bevy_reflect_derive/src
radiish 1efc762924
reflect: stable type path v2 (#7184)
# Objective

- Introduce a stable alternative to
[`std::any::type_name`](https://doc.rust-lang.org/std/any/fn.type_name.html).
- Rewrite of #5805 with heavy inspiration in design.
- On the path to #5830.
- Part of solving #3327.


## Solution

- Add a `TypePath` trait for static stable type path/name information.
- Add a `TypePath` derive macro.
- Add a `impl_type_path` macro for implementing internal and foreign
types in `bevy_reflect`.

---

## Changelog

- Added `TypePath` trait.
- Added `DynamicTypePath` trait and `get_type_path` method to `Reflect`.
- Added a `TypePath` derive macro.
- Added a `bevy_reflect::impl_type_path` for implementing `TypePath` on
internal and foreign types in `bevy_reflect`.
- Changed `bevy_reflect::utility::(Non)GenericTypeInfoCell` to
`(Non)GenericTypedCell<T>` which allows us to be generic over both
`TypeInfo` and `TypePath`.
- `TypePath` is now a supertrait of `Asset`, `Material` and
`Material2d`.
- `impl_reflect_struct` needs a `#[type_path = "..."]` attribute to be
specified.
- `impl_reflect_value` needs to either specify path starting with a
double colon (`::core::option::Option`) or an `in my_crate::foo`
declaration.
- Added `bevy_reflect_derive::ReflectTypePath`.
- Most uses of `Ident` in `bevy_reflect_derive` changed to use
`ReflectTypePath`.

## Migration Guide

- Implementors of `Asset`, `Material` and `Material2d` now also need to
derive `TypePath`.
- Manual implementors of `Reflect` will need to implement the new
`get_type_path` method.

## Open Questions
- [x] ~This PR currently does not migrate any usages of
`std::any::type_name` to use `bevy_reflect::TypePath` to ease the review
process. Should it?~ Migration will be left to a follow-up PR.
- [ ] This PR adds a lot of `#[derive(TypePath)]` and `T: TypePath` to
satisfy new bounds, mostly when deriving `TypeUuid`. Should we make
`TypePath` a supertrait of `TypeUuid`? [Should we remove `TypeUuid` in
favour of
`TypePath`?](2afbd85532 (r961067892))
2023-06-05 20:31:20 +00:00
..
impls reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00
container_attributes.rs update syn, encase, glam and hexasphere (#8573) 2023-05-16 01:24:17 +00:00
derive_data.rs reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00
documentation.rs update syn, encase, glam and hexasphere (#8573) 2023-05-16 01:24:17 +00:00
enum_utility.rs bevy_reflect: Allow #[reflect(default)] on enum variant fields (#8514) 2023-05-29 15:29:29 +00:00
field_attributes.rs update syn, encase, glam and hexasphere (#8573) 2023-05-16 01:24:17 +00:00
fq_std.rs Enable deriving Reflect on structs with generic types (#7364) 2023-01-28 00:12:06 +00:00
from_reflect.rs reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00
lib.rs reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00
reflect_value.rs reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00
registration.rs reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00
trait_reflection.rs Fix beta clippy lints (#7154) 2023-01-11 09:51:22 +00:00
type_path.rs reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00
type_uuid.rs update syn, encase, glam and hexasphere (#8573) 2023-05-16 01:24:17 +00:00
utility.rs reflect: stable type path v2 (#7184) 2023-06-05 20:31:20 +00:00