[Merged by Bors] - Document options for !Sync types for Component and Resources #6864
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
james7132
added
C-Docs
hymm
approved these changes
Dec 6, 2022
tim-blackbird
approved these changes
Dec 8, 2022
atlv24
approved these changes
Dec 9, 2022
alice-i-cecile
added
the
S-Ready-For-Final-Review
Co-authored-by: Atlas Dostal <[email protected]>
TimJentzsch
approved these changes
Dec 9, 2022
joseph-gio
approved these changes
Dec 9, 2022
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Dec 11, 2022
# Objective It's not clear to users how to handle `!Sync` types as components and resources in the absence of engine level support for them. ## Solution Added a section to `Component`'s and `Resource`'s type level docs on available options for making a type `Sync` when it holds `!Sync` fields, linking `bevy_utils::synccell::SyncCell` and the currently unstable `std::sync::Exclusive`. Also added a compile_fail doctest that illustrates how to apply `SyncCell`. These will break when/if #6572 gets merged, at which point these docs should be updated.
bors
bot
changed the title
alradish
pushed a commit
to alradish/bevy
that referenced
this pull request
Jan 22, 2023
…ine#6864) # Objective It's not clear to users how to handle `!Sync` types as components and resources in the absence of engine level support for them. ## Solution Added a section to `Component`'s and `Resource`'s type level docs on available options for making a type `Sync` when it holds `!Sync` fields, linking `bevy_utils::synccell::SyncCell` and the currently unstable `std::sync::Exclusive`. Also added a compile_fail doctest that illustrates how to apply `SyncCell`. These will break when/if bevyengine#6572 gets merged, at which point these docs should be updated.
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
…ine#6864) # Objective It's not clear to users how to handle `!Sync` types as components and resources in the absence of engine level support for them. ## Solution Added a section to `Component`'s and `Resource`'s type level docs on available options for making a type `Sync` when it holds `!Sync` fields, linking `bevy_utils::synccell::SyncCell` and the currently unstable `std::sync::Exclusive`. Also added a compile_fail doctest that illustrates how to apply `SyncCell`. These will break when/if bevyengine#6572 gets merged, at which point these docs should be updated.
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
It's not clear to users how to handle
!Synctypes as components and resources in the absence of engine level support for them.Solution
Added a section to
Component's andResource's type level docs on available options for making a typeSyncwhen it holds!Syncfields, linkingbevy_utils::synccell::SyncCelland the currently unstablestd::sync::Exclusive.Also added a compile_fail doctest that illustrates how to apply
SyncCell. These will break when/if #6572 gets merged, at which point these docs should be updated.