bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Additional doc links and explanation of Wake.

Browse source 
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).
This commit is contained in:
Kevin Reid 2023-10-03 08:53:40 -07:00
parent 4a2fe4491e
commit ccd6513c67
2 changed files with 26 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
library/alloc/src/task.rs
View file

@ -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 {