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.
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
watch::Sender: Modify and send value conditionally #4591
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c713603
watch::Sender: Modify and send value conditionally
uklotzde 2acc5de
watch::Sender Streamline control flow in send_if_modified()
uklotzde 6bd5cc5
watch::Sender Improve readability of send_if_modified()
uklotzde e577371
sync::watch: Improve docs of Sender::send_modify()/send_if_modified()
uklotzde 0e53b81
Merge branch 'master' of git@github.com:tokio-rs/tokio.git into watch…
uklotzde 2269791
Merge branch 'master' of git@github.com:tokio-rs/tokio.git into watch…
uklotzde File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although not modifying it when you return
false
is the intended use-case, I still think we should document what happens if you modify the value and then returnfalse
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While we are at it: Should we remove the redundancy in the docs and refer to the more versatile
send_if_modified()
in the docs forsend_modify()
? The docs would then basically reflect the forwarding of the implementation.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any improvements to the docs you can come up with would be good! Let me know when you think the docs are ready.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have revised and aligned the docs of both functions, highlighting their differences and similarities. Since I am not a native speaker someone should verify.
Removing the redundancies would be difficult. Copying the shared parts should be ok to keep the descriptions readable.