Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate StableHashMap/StableHashSet #11717

Closed
alice-i-cecile opened this issue Feb 5, 2024 · 0 comments · Fixed by #11721
Closed

Deprecate StableHashMap/StableHashSet #11717

alice-i-cecile opened this issue Feb 5, 2024 · 0 comments · Fixed by #11721
Labels
A-Utils Utility functions and types C-Code-Quality A section of code that is hard to understand or change D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

What problem does this solve or what need does it fill?

As discussed in #11690, Bevy no longer uses these types internally.

What solution would you like?

Because these are simple re-export of HashBrown types, we should just remove them from Bevy, and let users import the types themselves if needed.

Deprecating for a cycle offers a smoother migration path, as we can point users to the correct replacement.

What alternative(s) have you considered?

Just remove them immediately, which is slightly less worse but more annoying to migrate for users.

Keeping them is a poor choice, as we have no business owning all purpose hashmap types. See #11478.

@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy C-Code-Quality A section of code that is hard to understand or change A-Utils Utility functions and types labels Feb 5, 2024
github-merge-queue bot pushed a commit that referenced this issue Feb 6, 2024
# Objective

- The exported hashtypes are just re-exports from hashbrown, we want to
drop that dependency and (in the future) let the user import their own
choice.
- Fixes #11717

## Solution

- Adding a deprecated tag on the re-exports, so in future releases these
can be safely removed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Utils Utility functions and types C-Code-Quality A section of code that is hard to understand or change D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant