Clarify &mut-methods' docs on sync::OnceLock #140715
Open
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.
Three small changes to the docs of
sync::OnceLock
:OnceLock::take()
used to say "Safety is guaranteed by requiring a mutable reference." (emphasis mine). While technically correct, imho its not necessary to even mention safety - as opposed to unsafety - here: Safety never comes up wrtOnceLock
, as there is (currently) no way to interact with aOnceLock
in an unsafe way; there are no unsafe methods onOnceLock
, so there is "safety" guarantee required anywhere. What we simply meant to say is "Synchronization is guaranteed...".OnceLock
which take a&mut self
, to highlight the fact that having a&mut OnceLock
guarantees that synchronization with other threads is not required. This is the same as withMutex::get_mut()
,Cell::get_mut()
, and others.get_mut()
, as there is no way that theOnceLock
is being initialized while we are holding&mut
to it. Probably a copy&paste from.get()