mirror of
https://github.com/rust-lang/rust.git
synced 2024-12-21 04:54:26 +00:00
Docs: a LocalKey might start in the Valid state
This commit is contained in:
parent
2d75213709
commit
a50fe312dc
@ -325,7 +325,10 @@ impl<T: 'static> LocalKey<T> {
|
||||
///
|
||||
/// Once the initialization expression succeeds, the key transitions to the
|
||||
/// `Valid` state which will guarantee that future calls to [`with`] will
|
||||
/// succeed within the thread.
|
||||
/// succeed within the thread. Some keys might skip the `Uninitialized`
|
||||
/// state altogether and start in the `Valid` state as an optimization
|
||||
/// (e.g. keys initialized with a constant expression), but no guarantees
|
||||
/// are made.
|
||||
///
|
||||
/// When a thread exits, each key will be destroyed in turn, and as keys are
|
||||
/// destroyed they will enter the `Destroyed` state just before the
|
||||
|
Loading…
Reference in New Issue
Block a user