task: fix some doc and test things related to stabilizing JoinSet (#…

…4965)
tokio-rs · Sep 1, 2022 · ce5d2a4 · ce5d2a4
1 parent e5467ca
commit ce5d2a4
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 36 deletions.
diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs
@@ -349,7 +349,11 @@
 //! Likewise, some parts of the API are only available with the same flag:
 //!
 //! - [`task::Builder`]
-//!  
+//! - Some methods on [`task::JoinSet`]
+//! - [`runtime::RuntimeMetrics`]
+//! - [`runtime::Builder::unhandled_panic`]
+//! - [`task::Id`]
+//!
 //! This flag enables **unstable** features. The public API of these features
 //! may break in 1.x releases. To enable these features, the `--cfg
 //! tokio_unstable` argument must be passed to `rustc` when compiling. This

diff --git a/tokio/src/macros/cfg.rs b/tokio/src/macros/cfg.rs
@@ -406,16 +406,6 @@ macro_rules! cfg_unstable {
     };
 }
 
-macro_rules! cfg_not_unstable {
-    ($($item:item)*) => {
-        $(
-            #[cfg(not(tokio_unstable))]
-            #[cfg_attr(docsrs, doc(cfg(not(tokio_unstable))))]
-            $item
-        )*
-    };
-}
-
 macro_rules! cfg_not_trace {
     ($($item:item)*) => {
         $(

diff --git a/tokio/src/runtime/tests/loom_join_set.rs b/tokio/src/runtime/tests/loom_join_set.rs
@@ -1,4 +1,3 @@
-#![cfg(tokio_unstable)]
 use crate::runtime::Builder;
 use crate::task::JoinSet;
 

diff --git a/tokio/src/task/mod.rs b/tokio/src/task/mod.rs
@@ -311,14 +311,14 @@ cfg_rt! {
     pub use join_set::JoinSet;
     pub use crate::runtime::task::AbortHandle;
 
-    cfg_not_unstable! {
-        mod join_set;
-    }
+    // Uses #[cfg(...)] instead of macro since the macro adds docsrs annotations.
+    #[cfg(not(tokio_unstable))]
+    mod join_set;
+    #[cfg(tokio_unstable)]
+    pub mod join_set;
 
     cfg_unstable! {
         pub use crate::runtime::task::Id;
-
-        pub mod join_set;
     }
 
     cfg_trace! {

diff --git a/tokio/tests/async_send_sync.rs b/tokio/tests/async_send_sync.rs
@@ -394,6 +394,14 @@ assert_value!(tokio::sync::watch::Ref<'_, YY>: !Send & Sync & Unpin);
 assert_value!(tokio::sync::watch::Sender<NN>: !Send & !Sync & Unpin);
 assert_value!(tokio::sync::watch::Sender<YN>: !Send & !Sync & Unpin);
 assert_value!(tokio::sync::watch::Sender<YY>: Send & Sync & Unpin);
+assert_value!(tokio::task::JoinError: Send & Sync & Unpin);
+assert_value!(tokio::task::JoinHandle<NN>: !Send & !Sync & Unpin);
+assert_value!(tokio::task::JoinHandle<YN>: Send & Sync & Unpin);
+assert_value!(tokio::task::JoinHandle<YY>: Send & Sync & Unpin);
+assert_value!(tokio::task::JoinSet<NN>: !Send & !Sync & Unpin);
+assert_value!(tokio::task::JoinSet<YN>: Send & Sync & Unpin);
+assert_value!(tokio::task::JoinSet<YY>: Send & Sync & Unpin);
+assert_value!(tokio::task::LocalSet: !Send & !Sync & Unpin);
 async_assert_fn!(tokio::sync::Barrier::wait(_): Send & Sync & !Unpin);
 async_assert_fn!(tokio::sync::Mutex<NN>::lock(_): !Send & !Sync & !Unpin);
 async_assert_fn!(tokio::sync::Mutex<NN>::lock_owned(_): !Send & !Sync & !Unpin);
@@ -466,6 +474,12 @@ async_assert_fn!(tokio::sync::watch::Receiver<YY>::changed(_): Send & Sync & !Un
 async_assert_fn!(tokio::sync::watch::Sender<NN>::closed(_): !Send & !Sync & !Unpin);
 async_assert_fn!(tokio::sync::watch::Sender<YN>::closed(_): !Send & !Sync & !Unpin);
 async_assert_fn!(tokio::sync::watch::Sender<YY>::closed(_): Send & Sync & !Unpin);
+async_assert_fn!(tokio::task::JoinSet<Cell<u32>>::join_next(_): Send & Sync & !Unpin);
+async_assert_fn!(tokio::task::JoinSet<Cell<u32>>::shutdown(_): Send & Sync & !Unpin);
+async_assert_fn!(tokio::task::JoinSet<Rc<u32>>::join_next(_): !Send & !Sync & !Unpin);
+async_assert_fn!(tokio::task::JoinSet<Rc<u32>>::shutdown(_): !Send & !Sync & !Unpin);
+async_assert_fn!(tokio::task::JoinSet<u32>::join_next(_): Send & Sync & !Unpin);
+async_assert_fn!(tokio::task::JoinSet<u32>::shutdown(_): Send & Sync & !Unpin);
 async_assert_fn!(tokio::task::LocalKey<Cell<u32>>::scope(_, Cell<u32>, BoxFuture<()>): !Send & !Sync & !Unpin);
 async_assert_fn!(tokio::task::LocalKey<Cell<u32>>::scope(_, Cell<u32>, BoxFutureSend<()>): Send & !Sync & !Unpin);
 async_assert_fn!(tokio::task::LocalKey<Cell<u32>>::scope(_, Cell<u32>, BoxFutureSync<()>): Send & !Sync & !Unpin);
@@ -479,24 +493,6 @@ async_assert_fn!(tokio::task::LocalSet::run_until(_, BoxFutureSync<()>): !Send &
 async_assert_fn!(tokio::task::unconstrained(BoxFuture<()>): !Send & !Sync & Unpin);
 async_assert_fn!(tokio::task::unconstrained(BoxFutureSend<()>): Send & !Sync & Unpin);
 async_assert_fn!(tokio::task::unconstrained(BoxFutureSync<()>): Send & Sync & Unpin);
-assert_value!(tokio::task::JoinError: Send & Sync & Unpin);
-assert_value!(tokio::task::JoinHandle<NN>: !Send & !Sync & Unpin);
-assert_value!(tokio::task::JoinHandle<YN>: Send & Sync & Unpin);
-assert_value!(tokio::task::JoinHandle<YY>: Send & Sync & Unpin);
-#[cfg(tokio_unstable)]
-mod unstable {
-    use super::*;
-    async_assert_fn!(tokio::task::JoinSet<Cell<u32>>::join_next(_): Send & Sync & !Unpin);
-    async_assert_fn!(tokio::task::JoinSet<Cell<u32>>::shutdown(_): Send & Sync & !Unpin);
-    async_assert_fn!(tokio::task::JoinSet<Rc<u32>>::join_next(_): !Send & !Sync & !Unpin);
-    async_assert_fn!(tokio::task::JoinSet<Rc<u32>>::shutdown(_): !Send & !Sync & !Unpin);
-    async_assert_fn!(tokio::task::JoinSet<u32>::join_next(_): Send & Sync & !Unpin);
-    async_assert_fn!(tokio::task::JoinSet<u32>::shutdown(_): Send & Sync & !Unpin);
-    assert_value!(tokio::task::JoinSet<YY>: Send & Sync & Unpin);
-    assert_value!(tokio::task::JoinSet<YN>: Send & Sync & Unpin);
-    assert_value!(tokio::task::JoinSet<NN>: !Send & !Sync & Unpin);
-    assert_value!(tokio::task::LocalSet: !Send & !Sync & Unpin);
-}
 
 assert_value!(tokio::runtime::Builder: Send & Sync & Unpin);
 assert_value!(tokio::runtime::EnterGuard<'_>: Send & Sync & Unpin);

diff --git a/tokio/tests/task_join_set.rs b/tokio/tests/task_join_set.rs
@@ -1,5 +1,5 @@
 #![warn(rust_2018_idioms)]
-#![cfg(all(feature = "full", tokio_unstable))]
+#![cfg(all(feature = "full"))]
 
 use tokio::sync::oneshot;
 use tokio::task::JoinSet;