Skip to content

document expectations for Waker::wake #93966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 25, 2022
Merged

document expectations for Waker::wake #93966

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f52ebaa
document expectations for Waker::wake
rkuhn Feb 13, 2022
2946f7a
improve wording of Waker::wake documentation
rkuhn Feb 20, 2022
3d808d5
add caveat discussed in #74335
rkuhn May 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
add caveat discussed in #74335
  • Loading branch information
@rkuhn
rkuhn authored May 4, 2022
commit 3d808d52dec3db864532403f980a38ff98e3af8a
4 changes: 4 additions & 0 deletions library/core/src/task/wake.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,10 @@ impl Waker {
///
/// Note that the above implies that multiple wake-ups may be coalesced into a
/// single `poll` invocation by the runtime.
///
/// Also note that yielding to competing tasks is not guaranteed: it is the
/// executor’s choice which task to run and the executor may choose to run the
/// current task again.
#[inline]
#[stable(feature = "futures_api", since = "1.36.0")]
pub fn wake(self) {
Expand Down