Make SystemParam::new_archetype and QueryState::new_archetype unsafe functions #13044
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
Fix #2128. Both
Query::new_archetype
andSystemParam::new_archetype
do not check if theArchetype
comes from the same World the state is initialized from. This could result in unsoundness via invalid accesses if called incorrectly.Solution
Make them
unsafe
functions and lift the invariant to the caller. This also caught one instance of us not validating the World inSystemState::update_archetypes_unsafe_world_cell
's implementation.Changelog
Changed:
QueryState::new_archetype
is now an unsafe function.Changed:
SystemParam::new_archetype
is now an unsafe function.Migration Guide
QueryState::new_archetype
andSystemParam::new_archetype
are now an unsafe functions that must be sure that the providedArchetype
is from the sameWorld
that the state was initialized from. Callers may need to add additional assertions or propagate the safety invariant upwards through the callstack to ensure safety.