Make drain take a mutable borrow instead of Box<Self> for reflected Map, List, and Set.#15406
Merged
alice-i-cecile merged 3 commits intobevyengine:mainfrom Sep 30, 2024
Merged
Make drain take a mutable borrow instead of Box<Self> for reflected Map, List, and Set.#15406alice-i-cecile merged 3 commits intobevyengine:mainfrom
drain take a mutable borrow instead of Box<Self> for reflected Map, List, and Set.#15406alice-i-cecile merged 3 commits intobevyengine:mainfrom
Conversation
…ed `Map`, `List`, and `Set`. Some notable exceptions to this change are `Array` and `Tuple`. These types don't make sense with `drain` taking a mutable borrow since they can't get "smaller".
pablo-lua
reviewed
Sep 24, 2024
MrGVSV
approved these changes
Sep 25, 2024
…l value is left empty.
BenjaminBrienen
approved these changes
Sep 26, 2024
MrGVSV
reviewed
Sep 26, 2024
kristoff3r
approved these changes
Sep 26, 2024
pablo-lua
approved these changes
Sep 26, 2024
Contributor
pablo-lua
left a comment
There was a problem hiding this comment.
I think this is a major upgrade of the api, its more simple to pass a mut reference. All good, lgtm
robtfm
pushed a commit
to robtfm/bevy
that referenced
this pull request
Oct 4, 2024
…ed `Map`, `List`, and `Set`. (bevyengine#15406) # Objective Fixes bevyengine#15185. # Solution Change `drain` to take a `&mut self` for most reflected types. Some notable exceptions to this change are `Array` and `Tuple`. These types don't make sense with `drain` taking a mutable borrow since they can't get "smaller". Also `BTreeMap` doesn't have a `drain` function, so we have to pop elements off one at a time. ## Testing - The existing tests are sufficient. --- ## Migration Guide - `reflect::Map`, `reflect::List`, and `reflect::Set` all now take a `&mut self` instead of a `Box<Self>`. Callers of these traits should add `&mut` before their boxes, and implementers of these traits should update to match.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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
Fixes #15185.
Solution
Change
drainto take a&mut selffor most reflected types.Some notable exceptions to this change are
ArrayandTuple. These types don't make sense withdraintaking a mutable borrow since they can't get "smaller". AlsoBTreeMapdoesn't have adrainfunction, so we have to pop elements off one at a time.Testing
Migration Guide
reflect::Map,reflect::List, andreflect::Setall now take a&mut selfinstead of aBox<Self>. Callers of these traits should add&mutbefore their boxes, and implementers of these traits should update to match.