sync: add mpsc::Sender::capacity
#3690
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
Darksonn
reviewed
Apr 11, 2021
tokio/src/sync/mpsc/bounded.rs
Outdated
| /// assert_eq!(tx.available_permits(), 5); | ||
| /// } | ||
| /// ``` | ||
| pub fn available_permits(&self) -> usize { |
There was a problem hiding this comment.
This method should probably not be called available_permits.
tokio/src/sync/mpsc/bounded.rs
Outdated
Comment on lines
703
to
705
| /// Returns the number of available permits in the channel. | ||
| /// | ||
| /// # Examples |
There was a problem hiding this comment.
It's fine that you use reserve in the example, but it'd be nice to mention up here too.
There was a problem hiding this comment.
I've tweaked the docs a bit. Let me know what you think.
davidpdrsn
changed the title
mpsc::Sender::available_permitsmpsc::Sender::capacity
Darksonn
approved these changes
Apr 12, 2021
Merged
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.
Fixes #2642