Skip to content

sync: improve the docs for the errors of mpsc #7722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martin-g merged 3 commits into from
Nov 5, 2025
Merged

sync: improve the docs for the errors of mpsc #7722

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da9c505
docs: fix documentation comments for mpsc error enums
tqwewe Nov 5, 2025
b51d986
docs: improve code docs for `TryRecvError`
tqwewe Nov 5, 2025
0fd575b
docs: improve code docs for mpsc `SendError`
tqwewe Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions tokio/src/sync/mpsc/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
use std::error::Error;
use std::fmt;

/// Error returned by the `Sender`.
/// Error returned by [`Sender::send`](super::Sender::send).
#[derive(PartialEq, Eq, Clone, Copy)]
pub struct SendError<T>(pub T);

Expand All @@ -23,8 +23,7 @@ impl<T> Error for SendError<T> {}

// ===== TrySendError =====

/// This enumeration is the list of the possible error outcomes for the
/// [`try_send`](super::Sender::try_send) method.
/// Error returned by [`Sender::try_send`](super::Sender::try_send).
#[derive(PartialEq, Eq, Clone, Copy)]
pub enum TrySendError<T> {
/// The data could not be sent on the channel because the channel is
Expand Down Expand Up @@ -78,7 +77,7 @@ impl<T> From<SendError<T>> for TrySendError<T> {

// ===== TryRecvError =====

/// Error returned by `try_recv`.
/// Error returned by [`Receiver::try_recv`](super::Receiver::try_recv).
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
pub enum TryRecvError {
/// This **channel** is currently empty, but the **Sender**(s) have not yet
Expand Down Expand Up @@ -122,7 +121,7 @@ cfg_time! {
// ===== SendTimeoutError =====

#[derive(PartialEq, Eq, Clone, Copy)]
/// Error returned by [`Sender::send_timeout`](super::Sender::send_timeout)].
/// Error returned by [`Sender::send_timeout`](super::Sender::send_timeout).
pub enum SendTimeoutError<T> {
/// The data could not be sent on the channel because the channel is
/// full, and the timeout to send has elapsed.
Expand Down
Loading