Add note about current_thread + Handle::block_on #5264
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
There's already an existing warning about this combo in the documentation for `Handle::block_on`. This commit adds a summarized version in `Runtime::handle`.
|
I'm the friend in question, and the note added here would have saved me quite a bit of headache. I found |
Noah-Kennedy
approved these changes
Dec 5, 2022
|
Thanks! |
Darksonn
added
A-tokio
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.
A friend ran into the
current_thread+Handle::block_onIO-bound task issue today; I figured an additional note about it in the docs may be helpful.There's already an existing warning about this combination in the documentation for
Handle::block_on. This PR adds a warning in the docs forRuntime::handleand points toHandle::block_onfor more info.If this isn't something y'all are interested in, I would totally understand - I figured it doesn't take long to make a PR, so it's easier to discuss here :)