about summary refs log tree commit diff
path: root/compiler/rustc_codegen_llvm/src
diff options
context:
space:
mode:
authorMahmoud Al-Qudsi <mqudsi@neosmart.net>2024-05-24 12:10:05 -0500
committerMahmoud Al-Qudsi <mqudsi@neosmart.net>2024-05-24 12:15:06 -0500
commit65dffc1990f91b470f23175ef243bdd5e0b5313a (patch)
tree7d0463d5bf1437129b21be88ba99de3300c742e0 /compiler/rustc_codegen_llvm/src
parent213ad10c8f0fc275648552366275dc4e07f97462 (diff)
downloadrust-65dffc1990f91b470f23175ef243bdd5e0b5313a.tar.gz
rust-65dffc1990f91b470f23175ef243bdd5e0b5313a.zip
Change pedantically incorrect OnceCell/OnceLock wording
While the semantic intent of a OnceCell/OnceLock is that it can only be written
to once (upon init), the fact of the matter is that both these types offer a
`take(&mut self) -> Option<T>` mechanism that, when successful, resets the cell
to its initial state, thereby technically allowing it to be written to again.

Despite the fact that this can only happen with a mutable reference (generally
only used during the construction of the OnceCell/OnceLock), it would be
incorrect to say that the type itself as a whole categorically prevents being
initialized or written to more than once (since it is possible to imagine an
identical type only without the `take()` method that actually fulfills that
contract).

To clarify, change "that cannot be.." to "that nominally cannot.." and add a
note to OnceCell about what can be done with an `&mut Self` reference.
Diffstat (limited to 'compiler/rustc_codegen_llvm/src')
0 files changed, 0 insertions, 0 deletions