Make sync::watch::Sender::subscribe public
#3800
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make the internal watch::Sender::subscribe method public. Also adds documentation.
|
Note: the I don't see why this was the case, maybe because it was only required in other code behind the feature? |
Darksonn
reviewed
May 26, 2021
tokio/src/sync/watch.rs
Outdated
Comment on lines
412
to
413
| /// Creates a new [`Receiver`] handle that will receive values sent **after** | ||
| /// this call to `subscribe`. |
There was a problem hiding this comment.
Suggested change
| /// Creates a new [`Receiver`] handle that will receive values sent **after** | |
| /// this call to `subscribe`. | |
| /// Creates a new [`Receiver`] handle that will receive values sent after | |
| /// this call to `subscribe`. |
tokio/src/sync/watch.rs
Outdated
Comment on lines
412
to
415
| /// Creates a new [`Receiver`] handle that will receive values sent **after** | ||
| /// this call to `subscribe`. | ||
| /// | ||
| /// # Examples |
There was a problem hiding this comment.
Can you add a note about how this method behaves if the channel is closed when you call it? And preferably also add a test for that behavior?
|
What's the status on this PR? |
|
I'll get to to it in the next few days - today or tomorrow hopefully. |
Darksonn
changed the title
sync::watch::Sender::subscribe public
carllerche
approved these changes
Aug 18, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Unlike with
sync::broadcast::Sender, thesync::watch::Sender::subscribemethod is currently not public.This means handing out new subscriptions means keeping around a redundant Receiver, which is pretty unergonomic.
I don't really see a reason why this is the case, since the data structuredoesn't seem to have any relevant restrictions.
This was also requested in #3757.
Solution
Make
watch::Sender::subscribepublic.Also adds a doc test.