mirror of https://github.com/rust-lang/rust.git
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.
This commit is contained in:
parent
213ad10c8f
commit
65dffc1990
|
@ -2,12 +2,12 @@ use crate::cell::UnsafeCell;
|
|||
use crate::fmt;
|
||||
use crate::mem;
|
||||
|
||||
/// A cell which can be written to only once.
|
||||
/// A cell which can nominally be written to only once.
|
||||
///
|
||||
/// This allows obtaining a shared `&T` reference to its inner value without copying or replacing
|
||||
/// it (unlike [`Cell`]), and without runtime borrow checks (unlike [`RefCell`]). However,
|
||||
/// only immutable references can be obtained unless one has a mutable reference to the cell
|
||||
/// itself.
|
||||
/// itself. In the same vein, the cell can only be re-initialized with such a mutable reference.
|
||||
///
|
||||
/// For a thread-safe version of this struct, see [`std::sync::OnceLock`].
|
||||
///
|
||||
|
|
|
@ -5,7 +5,7 @@ use crate::mem::MaybeUninit;
|
|||
use crate::panic::{RefUnwindSafe, UnwindSafe};
|
||||
use crate::sync::Once;
|
||||
|
||||
/// A synchronization primitive which can be written to only once.
|
||||
/// A synchronization primitive which can nominally be written to only once.
|
||||
///
|
||||
/// This type is a thread-safe [`OnceCell`], and can be used in statics.
|
||||
///
|
||||
|
|
Loading…
Reference in New Issue