tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-08-26 00:00:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

sync: specify return type of oneshot::Receiver in docs (#5198)

Browse Source
This commit is contained in:
Lucas Kent
2022-11-17 11:56:56 +01:00
committed by GitHub
parent a668020150
commit 1cbbcc9ad5
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/sync/oneshot.rs
+3 -1
View File
@@ -227,7 +227,7 @@ pub struct Sender<T> {
/// [`channel`](fn@channel) function. /// [`channel`](fn@channel) function.
/// ///
/// This channel has no `recv` method because the receiver itself implements the /// 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<T, `[`error::RecvError`]`>`, `.await` the `Receiver` object directly.
/// ///
/// The `poll` method on the `Future` trait is allowed to spuriously return /// 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 /// `Poll::Pending` even if the message has been sent. If such a spurious
@@ -331,6 +331,8 @@ pub mod error {
use std::fmt; use std::fmt;
/// Error returned by the `Future` implementation for `Receiver`. /// 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)] #[derive(Debug, Eq, PartialEq, Clone)]
pub struct RecvError(pub(super) ()); pub struct RecvError(pub(super) ());