Document that blocking and async do not mix
#1159
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
See discussion on seanmonstar#1017. This patch adds documentation to `blocking` at module level and to its `Client::new` and `ClientBuilder::build`, noting that you can’t create or use a blocking client from within an async runtime, and suggesting potential alternatives. Presumably, all the other methods on `Client` also have this property, but hitting the failure mode would require building a `blocking::Client` outside an async runtime and then moving it into a runtime to send requests; seems potentially not worth polluting all the docs. Test Plan: Ran `cargo doc --features blocking` and verified that the links work. wchargin-branch: docs-blocking-no-async wchargin-source: 0eb36352959cd2ca0b19df5836e75230dc619b9d
seanmonstar
approved these changes
Feb 5, 2021
This was referenced Mar 12, 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.
See discussion on #1017. This patch adds documentation to
blockingatmodule level and to its
Client::newandClientBuilder::build, notingthat you can’t create or use a blocking client from within an async
runtime, and suggesting potential alternatives.
Presumably, all the other methods on
Clientalso have this property,but hitting the failure mode would require building a
blocking::Clientoutside an async runtime and then moving it into a runtime to send
requests; seems potentially not worth polluting all the docs.
Test Plan:
Ran
cargo doc --features blockingand verified that the links work.wchargin-branch: docs-blocking-no-async