Skip to content

Stabilize scoped threads. #97992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 12, 2022
Merged

Stabilize scoped threads. #97992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions library/core/src/sync/atomic.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ impl AtomicBool {
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, inline_const, scoped_threads)]
/// #![feature(atomic_from_mut, inline_const)]
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let mut some_bools = [const { AtomicBool::new(false) }; 10];
Expand Down Expand Up @@ -381,7 +381,7 @@ impl AtomicBool {
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, scoped_threads)]
/// #![feature(atomic_from_mut)]
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let mut some_bools = [false; 10];
Expand Down Expand Up @@ -1015,7 +1015,7 @@ impl<T> AtomicPtr<T> {
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, inline_const, scoped_threads)]
/// #![feature(atomic_from_mut, inline_const)]
/// use std::ptr::null_mut;
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
Expand Down Expand Up @@ -1052,7 +1052,7 @@ impl<T> AtomicPtr<T> {
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, scoped_threads)]
/// #![feature(atomic_from_mut)]
/// use std::ptr::null_mut;
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
Expand Down Expand Up @@ -1607,7 +1607,7 @@ macro_rules! atomic_int {
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, inline_const, scoped_threads)]
/// #![feature(atomic_from_mut, inline_const)]
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let mut some_ints = [const { ", stringify!($atomic_type), "::new(0) }; 10];")]
Expand Down Expand Up @@ -1640,7 +1640,7 @@ macro_rules! atomic_int {
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, scoped_threads)]
/// #![feature(atomic_from_mut)]
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
/// let mut some_ints = [0; 10];
Expand Down
4 changes: 2 additions & 2 deletions library/std/src/thread/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,10 @@ use crate::time::Duration;
#[macro_use]
mod local;

#[unstable(feature = "scoped_threads", issue = "93203")]
#[stable(feature = "scoped_threads", since = "1.63.0")]
mod scoped;

#[unstable(feature = "scoped_threads", issue = "93203")]
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub use scoped::{scope, Scope, ScopedJoinHandle};

#[stable(feature = "rust1", since = "1.0.0")]
Expand Down
18 changes: 10 additions & 8 deletions library/std/src/thread/scoped.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use crate::sync::Arc;
/// A scope to spawn scoped threads in.
///
/// See [`scope`] for details.
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub struct Scope<'scope, 'env: 'scope> {
data: ScopeData,
/// Invariance over 'scope, to make sure 'scope cannot shrink,
Expand All @@ -17,8 +18,6 @@ pub struct Scope<'scope, 'env: 'scope> {
/// Without invariance, this would compile fine but be unsound:
///
/// ```compile_fail,E0373
/// #![feature(scoped_threads)]
///
/// std::thread::scope(|s| {
/// s.spawn(|| {
/// let a = String::from("abcd");
Expand All @@ -33,6 +32,7 @@ pub struct Scope<'scope, 'env: 'scope> {
/// An owned permission to join on a scoped thread (block on its termination).
///
/// See [`Scope::spawn`] for details.
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub struct ScopedJoinHandle<'scope, T>(JoinInner<'scope, T>);

pub(super) struct ScopeData {
Expand Down Expand Up @@ -82,7 +82,6 @@ impl ScopeData {
/// # Example
///
/// ```
/// #![feature(scoped_threads)]
/// use std::thread;
///
/// let mut a = vec![1, 2, 3];
Expand Down Expand Up @@ -126,6 +125,7 @@ impl ScopeData {
///
/// The `'env: 'scope` bound is part of the definition of the `Scope` type.
#[track_caller]
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn scope<'env, F, T>(f: F) -> T
where
F: for<'scope> FnOnce(&'scope Scope<'scope, 'env>) -> T,
Expand Down Expand Up @@ -183,6 +183,7 @@ impl<'scope, 'env> Scope<'scope, 'env> {
/// to recover from such errors.
///
/// [`join`]: ScopedJoinHandle::join
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
where
F: FnOnce() -> T + Send + 'scope,
Expand All @@ -207,7 +208,6 @@ impl Builder {
/// # Example
///
/// ```
/// #![feature(scoped_threads)]
/// use std::thread;
///
/// let mut a = vec![1, 2, 3];
Expand Down Expand Up @@ -240,6 +240,7 @@ impl Builder {
/// a.push(4);
/// assert_eq!(x, a.len());
/// ```
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn spawn_scoped<'scope, 'env, F, T>(
self,
scope: &'scope Scope<'scope, 'env>,
Expand All @@ -259,8 +260,6 @@ impl<'scope, T> ScopedJoinHandle<'scope, T> {
/// # Examples
///
/// ```
/// #![feature(scoped_threads)]
///
/// use std::thread;
///
/// thread::scope(|s| {
Expand All @@ -271,6 +270,7 @@ impl<'scope, T> ScopedJoinHandle<'scope, T> {
/// });
/// ```
#[must_use]
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn thread(&self) -> &Thread {
&self.0.thread
}
Expand All @@ -292,8 +292,6 @@ impl<'scope, T> ScopedJoinHandle<'scope, T> {
/// # Examples
///
/// ```
/// #![feature(scoped_threads)]
///
/// use std::thread;
///
/// thread::scope(|s| {
Expand All @@ -303,6 +301,7 @@ impl<'scope, T> ScopedJoinHandle<'scope, T> {
/// assert!(t.join().is_err());
/// });
/// ```
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn join(self) -> Result<T> {
self.0.join()
}
Expand All @@ -316,11 +315,13 @@ impl<'scope, T> ScopedJoinHandle<'scope, T> {
///
/// This function does not block. To block while waiting on the thread to finish,
/// use [`join`][Self::join].
#[stable(feature = "scoped_threads", since = "1.63.0")]
pub fn is_finished(&self) -> bool {
Arc::strong_count(&self.0.packet) == 1
}
}

#[stable(feature = "scoped_threads", since = "1.63.0")]
impl fmt::Debug for Scope<'_, '_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Scope")
Expand All @@ -331,6 +332,7 @@ impl fmt::Debug for Scope<'_, '_> {
}
}

#[stable(feature = "scoped_threads", since = "1.63.0")]
impl<'scope, T> fmt::Debug for ScopedJoinHandle<'scope, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ScopedJoinHandle").finish_non_exhaustive()
Expand Down