diff options
| author | Matthias Krüger <matthias.krueger@famsik.de> | 2024-08-26 17:25:32 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-08-26 17:25:32 +0200 |
| commit | b1c9064071d37c4371f8cfa159e977647b66121d (patch) | |
| tree | b51bcdaef0cc222e358b3a28d3f9f8bfbd4e039d | |
| parent | 68aff290fd790199e5cc6060ab4851046d0f1fa1 (diff) | |
| parent | 3153b7d7b4e2d528e13c40559e644bfca0735389 (diff) | |
| download | rust-b1c9064071d37c4371f8cfa159e977647b66121d.tar.gz rust-b1c9064071d37c4371f8cfa159e977647b66121d.zip | |
Rollup merge of #129539 - oconnor663:poll_link, r=tgross35
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"] |