Additional Documentation of IntoClientRequest on connect_async
#342
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
src/connect.rs
Outdated
Comment on lines
23
to
32
| /// let request = Request::builder() | ||
| /// .uri("wss://api.example.com") | ||
| /// .method(Method::GET) | ||
| /// .header("Sec-WebSocket-Key", "someUniqueValue") | ||
| /// .header("Sec-WebSocket-Version", "13") | ||
| /// .header("host", "api.example.com") | ||
| /// .header("Connection", "Upgrade") | ||
| /// .header("Upgrade", "websocket") | ||
| /// .body(()) | ||
| /// .unwrap(); |
There was a problem hiding this comment.
I think this kind of pattern is actually a bit problematic as it requires specifying all WebSocket headers properly. A more typical issue that people experience is that they just want to add one or more additional headers on top of what we generate automatically, see snapview/tungstenite-rs#327
There was a problem hiding this comment.
Ah, that's even better for my use case, too. I've updated the example if you're okay with adding it. Thanks!
zitsen
added a commit
to taosdata/tokio-tungstenite
that referenced
this pull request
Sep 9, 2024
* master: deps: update `rustls-native-certs` to 0.8 (snapview#348) Additional Documentation of `IntoClientRequest` on `connect_async` (snapview#342) Prepare 0.23.1 release
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.
I came across #92 when I needed this behavior for a use case of mine and wanted to save future searchers the trouble with an explicit example in the docs.
Let me know if there's anything I can change. My IDE didn't seem pleased with the formatting, even when adding the hidden
async fn example() { ... }around it.