Document SystemState + exclusive system patterns
#21709
Open
+40
−0
Conversation
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
|
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
| #[inline] | ||
| pub fn set_non_send(&mut self) { | ||
| self.flags |= SystemStateFlags::NON_SEND; | ||
| /// Alternatively, for exclusive systems the ECS can automatically cache a |
There was a problem hiding this comment.
I don't think that this is where this doc comment is meant to be at all.
alice-i-cecile
added
C-Docs
alice-i-cecile
changed the title
SystemState + exclusive system patterns
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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 #12587
This issue is a more specific form of #8770, which has been open for over nine months with no apparent resolution.
The caching example for SystemState in the documentation shows the use of a function-local struct to cache a SystemState object. However, caching a SystemState has gotten easier since this documentation was written - with the addition of ExclusiveSystemParam and its implementation on &'a mut SystemState
, we can have the ECS handle caching for us.
The documentation should be updated to reflect this.
Solution
Testing
No testing was needed; however, review should ensure I actually achieved the goal state above. I believe, to the best of my abilities, I have but I have never interacted with rust of a codebase as large as this before.