bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #110049 - SkiFire13:localkey-with-docs-fix, r=workingjubilee

Browse source 
Don't claim `LocalKey::with` prevents a reference to be sent across threads

The documentation for `LocalKey` claims that `with` yields a reference that cannot be sent across threads, but this is false since you can easily do that with scoped threads. What it actually prevents is the reference from outliving the current thread.
This commit is contained in:
Matthias Krüger 2023-05-15 17:12:44 +02:00 • committed by GitHub
commit c93c2985d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
library/std/src/thread/local.rs
View file

@ -18,8 +18,8 @@ use crate::fmt;
/// target platform. It is instantiated with the [`thread_local!`] macro and the /// target platform. It is instantiated with the [`thread_local!`] macro and the
/// primary method is the [`with`] method. /// primary method is the [`with`] method.
/// ///
/// The [`with`] method yields a reference to the contained value which cannot be /// The [`with`] method yields a reference to the contained value which cannot
/// sent across threads or escape the given closure. /// outlive the current thread or escape the given closure.
/// ///
/// [`thread_local!`]: crate::thread_local /// [`thread_local!`]: crate::thread_local
/// ///