sync: export sync::notify::Notified future publicly (#3840)

tokio-rs · Jun 14, 2021 · 21de476 · 21de476
1 parent cb147a2
commit 21de476
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/tokio/src/sync/mod.rs b/tokio/src/sync/mod.rs
@@ -428,6 +428,11 @@
 //!   bounding of any kind.
 
 cfg_sync! {
+    /// Named future types.
+    pub mod futures {
+        pub use super::notify::Notified;
+    }
+
     mod barrier;
     pub use barrier::{Barrier, BarrierWaitResult};
 

diff --git a/tokio/src/sync/notify.rs b/tokio/src/sync/notify.rs
@@ -140,7 +140,7 @@ struct Waiter {
     _p: PhantomPinned,
 }
 
-/// Future returned from `notified()`
+/// Future returned from [`Notify::notified()`]
 #[derive(Debug)]
 pub struct Notified<'a> {
     /// The `Notify` being received on.