stream: documentation note for throttle unpin #3600
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
Add a note in the documentation for Throttle that it can be made to implement Unpin by pinning it.
Darksonn
added
A-tokio-stream
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.
Add a note in the documentation for Throttle that it can be made to
implement Unpin by pinning it.
Motivation
I had trouble updating to tokio v1 because the
Throttlestruct is!Unpinand my code required it to beUnpin.I asked for help on the PR that I think made the change, #3278. In that discussion it was recommended that we document the fix.
Solution
Added a sentence to help anyone else in the same boat!