We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 1f4681a commit f52ebaaCopy full SHA for f52ebaa
library/core/src/task/wake.rs
@@ -219,6 +219,13 @@ unsafe impl Sync for Waker {}
219
220
impl Waker {
221
/// Wake up the task associated with this `Waker`.
222
+ ///
223
+ /// Multiple wake-ups (through clones of this `Waker` or `wake_by_ref`) may be
224
+ /// coalesced into a single `poll` invocation by the runtime, and as long as
225
+ /// the runtime keeps running and the task is not finished it is expected that
226
+ /// each wake-up is followed by an invocation of `poll`, even in the absence of
227
+ /// other events. This makes it possible to yield to other tasks when running
228
+ /// potentially unbounded processing loops in order to maintain fairness.
229
#[inline]
230
#[stable(feature = "futures_api", since = "1.36.0")]
231
pub fn wake(self) {
0 commit comments