sync: clarify the cancellation safety of `oneshot::Receiver` (#7780)

Signed-off-by: ADD-SP <qiqi.zhang@konghq.com>
Co-authored-by: Alice Ryhl <aliceryhl@google.com>

diff --git a/tokio/src/sync/oneshot.rs b/tokio/src/sync/oneshot.rs
index c5857f65491902dc12922f3d918987c7ad38ec84..32e28844257e151c0763784dab2980b741dba029 100644 (file)
--- a/tokio/src/sync/oneshot.rs
+++ b/tokio/src/sync/oneshot.rs
@@ -243,6 +243,13 @@ pub struct Sender<T> {
 ///
 /// [`Future`]: trait@std::future::Future
 ///
+/// # Cancellation safety
+///
+/// The `Receiver` is cancel safe. If it is used as the event in a
+/// [`tokio::select!`](crate::select) statement and some other branch
+/// completes first, it is guaranteed that no message was received on this
+/// channel.
+///
 /// # Examples
 ///
 /// ```