[Merged by Bors] - Enforce type safe usage of Handle::get #4794
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DJMcNab
added
A-Assets
|
Note to reviewers: ordinarily, I would flag this flavor of major API change as |
| fn get_asset<'world>( | ||
| id: &Handle<PngAsset>, | ||
| world: &'world World, | ||
| ) -> Option<&'world PngAsset> { |
There was a problem hiding this comment.
Note to reviewers: this is part of a test suite. Hence the overly broad name for a specific asset type.
I would probably rename the method here, but I don't feel strongly about it.
crates/bevy_ui/src/ui_node.rs
Outdated
| @@ -369,7 +370,7 @@ impl From<Color> for UiColor { | |||
| } | |||
|
|
|||
| /// The image of the node | |||
| #[derive(Component, Clone, Debug, Reflect)] | |||
| #[derive(Component, Clone, Debug, Reflect, Deref)] | |||
There was a problem hiding this comment.
We should have DerefMut to match IMO.
There was a problem hiding this comment.
Suggested change
| #[derive(Component, Clone, Debug, Reflect, Deref)] | |
| #[derive(Component, Clone, Debug, Reflect, Deref, DerefMut)] |
There was a problem hiding this comment.
We should have a full review of which things internally should use the Deref derives, I guess.
alice-i-cecile
approved these changes
May 18, 2022
bjorn3
reviewed
May 18, 2022
bjorn3
approved these changes
May 18, 2022
mockersf
approved these changes
May 18, 2022
alice-i-cecile
added
the
S-Ready-For-Final-Review
bors bot
pushed a commit
that referenced
this pull request
May 30, 2022
# Objective - Sometimes, people might load an asset as one type, then use it with an `Asset`s for a different type. - See e.g. #4784. - This is especially likely with the Gltf types, since users may not have a clear conceptual model of what types the assets will be. - We had an instance of this ourselves, in the `scene_viewer` example ## Solution - Make `Assets::get` require a type safe handle. --- ## Changelog ### Changed - `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. ### Added - `HandleUntyped::typed_weak`, a helper function for creating a weak typed version of an exisitng `HandleUntyped`. ## Migration Guide `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. If you were previously passing in: - a `HandleId`, use `&Handle::weak(id)` instead, to create a weak handle. You may have been able to store a type safe `Handle` instead. - a `HandleUntyped`, use `&handle_untyped.typed_weak()` to create a weak handle of the specified type. This is most likely to be the useful when using [load_folder](https://docs.rs/bevy_asset/latest/bevy_asset/struct.AssetServer.html#method.load_folder) - a `Handle<U>` of of a different type, consider whether this is the correct handle type to store. If it is (i.e. the same handle id is used for multiple different Asset types) use `Handle::weak(handle.id)` to cast to a different type.
bors
bot
changed the title
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Jun 7, 2022
# Objective - Sometimes, people might load an asset as one type, then use it with an `Asset`s for a different type. - See e.g. bevyengine#4784. - This is especially likely with the Gltf types, since users may not have a clear conceptual model of what types the assets will be. - We had an instance of this ourselves, in the `scene_viewer` example ## Solution - Make `Assets::get` require a type safe handle. --- ## Changelog ### Changed - `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. ### Added - `HandleUntyped::typed_weak`, a helper function for creating a weak typed version of an exisitng `HandleUntyped`. ## Migration Guide `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. If you were previously passing in: - a `HandleId`, use `&Handle::weak(id)` instead, to create a weak handle. You may have been able to store a type safe `Handle` instead. - a `HandleUntyped`, use `&handle_untyped.typed_weak()` to create a weak handle of the specified type. This is most likely to be the useful when using [load_folder](https://docs.rs/bevy_asset/latest/bevy_asset/struct.AssetServer.html#method.load_folder) - a `Handle<U>` of of a different type, consider whether this is the correct handle type to store. If it is (i.e. the same handle id is used for multiple different Asset types) use `Handle::weak(handle.id)` to cast to a different type.
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective - Sometimes, people might load an asset as one type, then use it with an `Asset`s for a different type. - See e.g. bevyengine#4784. - This is especially likely with the Gltf types, since users may not have a clear conceptual model of what types the assets will be. - We had an instance of this ourselves, in the `scene_viewer` example ## Solution - Make `Assets::get` require a type safe handle. --- ## Changelog ### Changed - `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. ### Added - `HandleUntyped::typed_weak`, a helper function for creating a weak typed version of an exisitng `HandleUntyped`. ## Migration Guide `Assets::<T>::get` and `Assets::<T>::get_mut` now require that the passed handles are `Handle<T>`, improving the type safety of handles. If you were previously passing in: - a `HandleId`, use `&Handle::weak(id)` instead, to create a weak handle. You may have been able to store a type safe `Handle` instead. - a `HandleUntyped`, use `&handle_untyped.typed_weak()` to create a weak handle of the specified type. This is most likely to be the useful when using [load_folder](https://docs.rs/bevy_asset/latest/bevy_asset/struct.AssetServer.html#method.load_folder) - a `Handle<U>` of of a different type, consider whether this is the correct handle type to store. If it is (i.e. the same handle id is used for multiple different Asset types) use `Handle::weak(handle.id)` to cast to a different type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Assets for a different type.scene_viewerexampleSolution
Assets::getrequire a type safe handle.Changelog
Changed
Assets::<T>::getandAssets::<T>::get_mutnow require that the passed handles areHandle<T>, improving the type safety of handles.Added
HandleUntyped::typed_weak, a helper function for creating a weak typed version of an exisitngHandleUntyped.Migration Guide
Assets::<T>::getandAssets::<T>::get_mutnow require that the passed handles areHandle<T>, improving the type safety of handles. If you were previously passing in:HandleId, use&Handle::weak(id)instead, to create a weak handle. You may have been able to store a type safeHandleinstead.HandleUntyped, use&handle_untyped.typed_weak()to create a weak handle of the specified type. This is most likely to be the useful when using load_folderHandle<U>of of a different type, consider whether this is the correct handle type to store. If it is (i.e. the same handle id is used for multiple different Asset types) useHandle::weak(handle.id)to cast to a different type.