diff options
| author | Jack O'Connor <oconnor663@gmail.com> | 2024-08-24 18:14:52 -0700 |
|---|---|---|
| committer | Jack O'Connor <oconnor663@gmail.com> | 2024-08-25 08:35:06 -0700 |
| commit | 3153b7d7b4e2d528e13c40559e644bfca0735389 (patch) | |
| tree | a89dccb93faaafc4553d577d7e944935d954b656 | |
| parent | 89103466d77a3ae068bab0fd17c53bf7104f627b (diff) | |
| download | rust-3153b7d7b4e2d528e13c40559e644bfca0735389.tar.gz rust-3153b7d7b4e2d528e13c40559e644bfca0735389.zip | |
link to Future::poll from the Poll docs
The most important thing about Poll is that Future::poll returns it, but previously the docs didn't emphasize this.
| -rw-r--r-- | library/core/src/task/poll.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/library/core/src/task/poll.rs b/library/core/src/task/poll.rs index bfa1cf096e2..6aab22177ab 100644 --- a/library/core/src/task/poll.rs +++ b/library/core/src/task/poll.rs @@ -5,6 +5,8 @@ use crate::ops::{self, ControlFlow}; /// Indicates whether a value is available or if the current task has been /// scheduled to receive a wakeup instead. +/// +/// This is returned by [`Future::poll`](core::future::Future::poll). #[must_use = "this `Poll` may be a `Pending` variant, which should be handled"] #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)] #[lang = "Poll"] |