Skip to content
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

Jump to bottom

sync: improve cancel-safety documentation for mpsc::Sender::send #5947

Merged
merged 3 commits into from Aug 25, 2023
Merged

sync: improve cancel-safety documentation for mpsc::Sender::send #5947

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
60508bd
sync: improve cancel-safety documentation for mpsc::Sender::send
sunshowers Aug 25, 2023
0b605d3
address review nit
sunshowers Aug 25, 2023
7f9509f
Merge branch 'master' into sender-docs
hawkw Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion tokio/src/sync/mpsc/bounded.rs
View file
Open in desktop
Expand Up @@ -439,7 +439,11 @@ impl<T> Sender<T> {
///
/// If `send` is used as the event in a [`tokio::select!`](crate::select)
/// statement and some other branch completes first, then it is guaranteed
/// that the message was not sent.
/// that the message was not sent. **However, in that case, the message
/// is dropped and will be lost.**
///
/// To avoid losing messages, use [`reserve`](Self::reserve) to reserve
/// capacity, then use the returned [`Permit`] to send the message.
///
/// This channel uses a queue to ensure that calls to `send` and `reserve`
/// complete in the order they were requested. Cancelling a call to
Expand Down