about summary refs log tree commit diff
path: root/library/alloc/src/task.rs
diff options
context:
space:
mode:
authorKevin Reid <kpreid@switchb.org>2023-10-03 08:53:40 -0700
committerKevin Reid <kpreid@switchb.org>2024-02-10 22:17:11 -0800
commitccd6513c6777e9f4083743bc80abc16cd7a744d6 (patch)
tree3b65c45c7628a40a0791aaee1e28853210dbff25 /library/alloc/src/task.rs
parent4a2fe4491ea616983a0cf0cbbd145a39768f4e7a (diff)
downloadrust-ccd6513c6777e9f4083743bc80abc16cd7a744d6.tar.gz
rust-ccd6513c6777e9f4083743bc80abc16cd7a744d6.zip
Additional doc links and explanation of `Wake`.
This is intended to clarify:

* That `Wake` exists and can be used instead of `RawWaker`.
* How to construct a `Waker` when you are looking at `Wake`
  (which was previously only documented in the example).
Diffstat (limited to 'library/alloc/src/task.rs')
-rw-r--r--library/alloc/src/task.rs12
1 files changed, 9 insertions, 3 deletions
diff --git a/library/alloc/src/task.rs b/library/alloc/src/task.rs
index 87db8629ad0..193c080d4bb 100644
--- a/library/alloc/src/task.rs
+++ b/library/alloc/src/task.rs
@@ -19,7 +19,7 @@ use core::task::Waker;
 /// The implementation of waking a task on an executor.
 ///
 /// This trait can be used to create a [`Waker`]. An executor can define an
-/// implementation of this trait, and use that to construct a Waker to pass
+/// implementation of this trait, and use that to construct a [`Waker`] to pass
 /// to the tasks that are executed on that executor.
 ///
 /// This trait is a memory-safe and ergonomic alternative to constructing a
@@ -28,7 +28,13 @@ use core::task::Waker;
 /// those for embedded systems) cannot use this API, which is why [`RawWaker`]
 /// exists as an alternative for those systems.
 ///
-/// [arc]: ../../std/sync/struct.Arc.html
+/// To construct a [`Waker`] from some type `W` implementing this trait,
+/// wrap it in an [`Arc<W>`](Arc) and call [`Waker::from()`][wi].
+/// It is also possible to convert to [`RawWaker`] in the same way.
+///
+/// <!-- This impl is reachable from `alloc` but rustdoc only lists it in `std`
+///      because `alloc` doesn't reexport `Waker` -->
+/// [wi]: ../../std/task/struct.Waker.html#impl-From<Arc<W,+Global>>-for-Waker
 ///
 /// # Examples
 ///
@@ -100,7 +106,7 @@ pub trait Wake {
 #[cfg(target_has_atomic = "ptr")]
 #[stable(feature = "wake_trait", since = "1.51.0")]
 impl<W: Wake + Send + Sync + 'static> From<Arc<W>> for Waker {
-    /// Use a `Wake`-able type as a `Waker`.
+    /// Use a [`Wake`]-able type as a `Waker`.
     ///
     /// No heap allocations or atomic operations are used for this conversion.
     fn from(waker: Arc<W>) -> Waker {