link to Future::poll from the Poll docs · patricklam/verify-rust-std@22ec897 (original) (raw)

Skip to content

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

Commit 22ec897

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.

File tree

1 file changed

lines changed

1 file changed

lines changed

Lines changed: 2 additions & 0 deletions

Original file line number Diff line number Diff line change
@@ -5,6 +5,8 @@ use crate::ops::{self, ControlFlow};
5 5
6 6 /// Indicates whether a value is available or if the current task has been
7 7 /// scheduled to receive a wakeup instead.
8 +///
9 +/// This is returned by [`Future::poll`](core::future::Future::poll).
8 10 #[must_use = "this `Poll` may be a `Pending` variant, which should be handled"]
9 11 #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
10 12 #[lang = "Poll"]