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: doc of watch::Sender::send improved #4959

Merged
merged 4 commits into from Sep 1, 2022
Merged

sync: doc of watch::Sender::send improved #4959

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d2bd60b
sync: doc of watch::Sender::send improved
JanBeh Aug 30, 2022
da8b888
amend! sync: doc of watch::Sender::send improved
JanBeh Aug 30, 2022
202db6e
fixup! amend! sync: doc of watch::Sender::send improved
JanBeh Aug 30, 2022
47a60f4
Merge branch 'master' into PR_doc_watch_send_fail
JanBeh Sep 1, 2022
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
10 changes: 8 additions & 2 deletions tokio/src/sync/watch.rs
View file
Open in desktop
Expand Up @@ -604,8 +604,14 @@ impl<T> Drop for Receiver<T> {
impl<T> Sender<T> {
/// Sends a new value via the channel, notifying all receivers.
///
/// This method fails if the channel has been closed, which happens when
/// every receiver has been dropped.
/// This method fails if the channel is closed, which is the case when
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would be worth adding something like "unlike the other methods for sending" to emphasize that only this method fails in this way.

Copy link
Contributor Author

@JanBeh JanBeh Aug 30, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for pointing that out; I added another note, mentioning that the other send methods can be used to send a value even if there isn't any receiver.

/// every receiver has been dropped. It is possible to reopen the channel
/// using the [`subscribe`] method. However, when `send` fails, the value
/// isn't made available for future receivers (but returned with the
/// [`SendError`]).
///
/// [`subscribe`]: Sender::subscribe
/// [`SendError`]: error::SendError
pub fn send(&self, value: T) -> Result<(), error::SendError<T>> {
// This is pretty much only useful as a hint anyway, so synchronization isn't critical.
if 0 == self.receiver_count() {
Expand Down