[Merged by Bors] - make Handle::<T> field id private, and replace with a getter #6176
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
mockersf
added
the
A-Assets
tim-blackbird
approved these changes
Oct 5, 2022
mockersf
added
the
M-Needs-Migration-Guide
zicklag
approved these changes
Oct 5, 2022
IceSentry
approved these changes
Oct 5, 2022
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Oct 6, 2022
# Objective - Field `id` of `Handle<T>` is public: https://docs.rs/bevy/latest/bevy/asset/struct.Handle.html#structfield.id - Changing the value of this field doesn't make sense as it could mean changing the previous handle without dropping it, breaking asset cleanup detection for the old handle and the new one ## Solution - Make the field private, and add a public getter Opened after discussion in #6171. Pinging @zicklag --- ## Migration Guide - If you were accessing the value `handle.id`, you can now do so with `handle.id()`
|
Pull request successfully merged into main. Build succeeded: |
bors
bot
changed the title
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 19, 2022
…ine#6176) # Objective - Field `id` of `Handle<T>` is public: https://docs.rs/bevy/latest/bevy/asset/struct.Handle.html#structfield.id - Changing the value of this field doesn't make sense as it could mean changing the previous handle without dropping it, breaking asset cleanup detection for the old handle and the new one ## Solution - Make the field private, and add a public getter Opened after discussion in bevyengine#6171. Pinging @zicklag --- ## Migration Guide - If you were accessing the value `handle.id`, you can now do so with `handle.id()`
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Oct 28, 2022
…ine#6176) # Objective - Field `id` of `Handle<T>` is public: https://docs.rs/bevy/latest/bevy/asset/struct.Handle.html#structfield.id - Changing the value of this field doesn't make sense as it could mean changing the previous handle without dropping it, breaking asset cleanup detection for the old handle and the new one ## Solution - Make the field private, and add a public getter Opened after discussion in bevyengine#6171. Pinging @zicklag --- ## Migration Guide - If you were accessing the value `handle.id`, you can now do so with `handle.id()`
neocturne
added a commit
to neocturne/bevy
that referenced
this pull request
Jan 2, 2023
# Objective It is currently possible to break reference counting for assets by creating a strong HandleUntyped and then modifying the `id` field before dropping the handle. This should not be allowed. ## Solution Change the `id` field visibility to private and add a getter instead. The same change was previously done for Handle<T> in bevyengine#6176, but HandleUntyped<T> was forgotten.
bors bot
pushed a commit
that referenced
this pull request
Jan 4, 2023
# Objective It is currently possible to break reference counting for assets by creating a strong `HandleUntyped` and then modifying the `id` field before dropping the handle. This should not be allowed. ## Solution Change the `id` field visibility to private and add a getter instead. The same change was previously done for `Handle<T>` in #6176, but `HandleUntyped` was forgotten. --- ## Migration Guide - Instead of directly accessing the ID of a `HandleUntyped` as `handle.id`, use the new getter `handle.id()`.
alradish
pushed a commit
to alradish/bevy
that referenced
this pull request
Jan 22, 2023
# Objective It is currently possible to break reference counting for assets by creating a strong `HandleUntyped` and then modifying the `id` field before dropping the handle. This should not be allowed. ## Solution Change the `id` field visibility to private and add a getter instead. The same change was previously done for `Handle<T>` in bevyengine#6176, but `HandleUntyped` was forgotten. --- ## Migration Guide - Instead of directly accessing the ID of a `HandleUntyped` as `handle.id`, use the new getter `handle.id()`.
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
…ine#6176) # Objective - Field `id` of `Handle<T>` is public: https://docs.rs/bevy/latest/bevy/asset/struct.Handle.html#structfield.id - Changing the value of this field doesn't make sense as it could mean changing the previous handle without dropping it, breaking asset cleanup detection for the old handle and the new one ## Solution - Make the field private, and add a public getter Opened after discussion in bevyengine#6171. Pinging @zicklag --- ## Migration Guide - If you were accessing the value `handle.id`, you can now do so with `handle.id()`
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
# Objective It is currently possible to break reference counting for assets by creating a strong `HandleUntyped` and then modifying the `id` field before dropping the handle. This should not be allowed. ## Solution Change the `id` field visibility to private and add a getter instead. The same change was previously done for `Handle<T>` in bevyengine#6176, but `HandleUntyped` was forgotten. --- ## Migration Guide - Instead of directly accessing the ID of a `HandleUntyped` as `handle.id`, use the new getter `handle.id()`.
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
idofHandle<T>is public: https://docs.rs/bevy/latest/bevy/asset/struct.Handle.html#structfield.idSolution
Opened after discussion in #6171. Pinging @zicklag
Migration Guide
handle.id, you can now do so withhandle.id()