From 1cbbcc9ad57ccf413f58d9dcd66d2ea7e68a0766 Mon Sep 17 00:00:00 2001 From: Lucas Kent Date: Thu, 17 Nov 2022 21:56:56 +1100 Subject: [PATCH] sync: specify return type of `oneshot::Receiver` in docs (#5198) --- tokio/src/sync/oneshot.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tokio/src/sync/oneshot.rs b/tokio/src/sync/oneshot.rs index f5718dc92f8..fcd7a32e8e8 100644 --- a/tokio/src/sync/oneshot.rs +++ b/tokio/src/sync/oneshot.rs @@ -227,7 +227,7 @@ pub struct Sender { /// [`channel`](fn@channel) function. /// /// This channel has no `recv` method because the receiver itself implements the -/// [`Future`] trait. To receive a value, `.await` the `Receiver` object directly. +/// [`Future`] trait. To receive a `Result`, `.await` the `Receiver` object directly. /// /// The `poll` method on the `Future` trait is allowed to spuriously return /// `Poll::Pending` even if the message has been sent. If such a spurious @@ -331,6 +331,8 @@ pub mod error { use std::fmt; /// Error returned by the `Future` implementation for `Receiver`. + /// + /// This error is returned by the receiver when the sender is dropped without sending. #[derive(Debug, Eq, PartialEq, Clone)] pub struct RecvError(pub(super) ());