mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 14:40:19 +00:00
992681b59b
*This PR description is an edited copy of #5007, written by @alice-i-cecile.* # Objective Follow-up to https://github.com/bevyengine/bevy/pull/2254. The `Resource` trait currently has a blanket implementation for all types that meet its bounds. While ergonomic, this results in several drawbacks: * it is possible to make confusing, silent mistakes such as inserting a function pointer (Foo) rather than a value (Foo::Bar) as a resource * it is challenging to discover if a type is intended to be used as a resource * we cannot later add customization options (see the [RFC](https://github.com/bevyengine/rfcs/blob/main/rfcs/27-derive-component.md) for the equivalent choice for Component). * dependencies can use the same Rust type as a resource in invisibly conflicting ways * raw Rust types used as resources cannot preserve privacy appropriately, as anyone able to access that type can read and write to internal values * we cannot capture a definitive list of possible resources to display to users in an editor ## Notes to reviewers * Review this commit-by-commit; there's effectively no back-tracking and there's a lot of churn in some of these commits. *ira: My commits are not as well organized :')* * I've relaxed the bound on Local to Send + Sync + 'static: I don't think these concerns apply there, so this can keep things simple. Storing e.g. a u32 in a Local is fine, because there's a variable name attached explaining what it does. * I think this is a bad place for the Resource trait to live, but I've left it in place to make reviewing easier. IMO that's best tackled with https://github.com/bevyengine/bevy/issues/4981. ## Changelog `Resource` is no longer automatically implemented for all matching types. Instead, use the new `#[derive(Resource)]` macro. ## Migration Guide Add `#[derive(Resource)]` to all types you are using as a resource. If you are using a third party type as a resource, wrap it in a tuple struct to bypass orphan rules. Consider deriving `Deref` and `DerefMut` to improve ergonomics. `ClearColor` no longer implements `Component`. Using `ClearColor` as a component in 0.8 did nothing. Use the `ClearColorConfig` in the `Camera3d` and `Camera2d` components instead. Co-authored-by: Alice <alice.i.cecile@gmail.com> Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> Co-authored-by: devil-ira <justthecooldude@gmail.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com> |
||
|---|---|---|
| .. | ||
| entity_ref_mut_lifetime_safety.rs | ||
| entity_ref_mut_lifetime_safety.stderr | ||
| query_combin_exact_sized_iterator_safety.rs | ||
| query_combin_exact_sized_iterator_safety.stderr | ||
| query_exact_sized_iterator_safety.rs | ||
| query_exact_sized_iterator_safety.stderr | ||
| query_iter_combinations_mut_iterator_safety.rs | ||
| query_iter_combinations_mut_iterator_safety.stderr | ||
| query_iter_many_mut_iterator_safety.rs | ||
| query_iter_many_mut_iterator_safety.stderr | ||
| query_lifetime_safety.rs | ||
| query_lifetime_safety.stderr | ||
| query_to_readonly.rs | ||
| query_to_readonly.stderr | ||
| system_param_derive_readonly.rs | ||
| system_param_derive_readonly.stderr | ||
| system_query_get_lifetime_safety.rs | ||
| system_query_get_lifetime_safety.stderr | ||
| system_query_get_many_lifetime_safety.rs | ||
| system_query_get_many_lifetime_safety.stderr | ||
| system_query_get_many_mut_lifetime_safety.rs | ||
| system_query_get_many_mut_lifetime_safety.stderr | ||
| system_query_iter_lifetime_safety.rs | ||
| system_query_iter_lifetime_safety.stderr | ||
| system_query_iter_many_mut_lifetime_safety.rs | ||
| system_query_iter_many_mut_lifetime_safety.stderr | ||
| system_query_set_get_lifetime_safety.rs | ||
| system_query_set_get_lifetime_safety.stderr | ||
| system_query_set_iter_lifetime_safety.rs | ||
| system_query_set_iter_lifetime_safety.stderr | ||
| system_state_get_lifetime_safety.rs | ||
| system_state_get_lifetime_safety.stderr | ||
| system_state_iter_lifetime_safety.rs | ||
| system_state_iter_lifetime_safety.stderr | ||
| system_state_iter_mut_overlap_safety.rs | ||
| system_state_iter_mut_overlap_safety.stderr | ||
| world_query_derive.rs | ||
| world_query_derive.stderr | ||