about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRoland Kuhn <rk@rkuhn.info>2022-05-04 10:58:23 +0200
committerGitHub <noreply@github.com>2022-05-04 10:58:23 +0200
commit3d808d52dec3db864532403f980a38ff98e3af8a (patch)
treea59b6b9b9af0e705decf4569427e9a4c99a802bd
parent2946f7aad17c5445c3837a6691bf2b7f51e883a8 (diff)
downloadrust-3d808d52dec3db864532403f980a38ff98e3af8a.tar.gz
rust-3d808d52dec3db864532403f980a38ff98e3af8a.zip
add caveat discussed in #74335
-rw-r--r--library/core/src/task/wake.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/library/core/src/task/wake.rs b/library/core/src/task/wake.rs
index 301cfacb554..9e74bcc541e 100644
--- a/library/core/src/task/wake.rs
+++ b/library/core/src/task/wake.rs
@@ -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) {