docs: document cancel safety for client send_request futures#4070
Open
lihan3238 wants to merge 1 commit into
Open
docs: document cancel safety for client send_request futures#4070lihan3238 wants to merge 1 commit into
lihan3238 wants to merge 1 commit into
Conversation
Per discussion in hyperium#4054: hyper futures are cancel safe via drop. Document the protocol-specific behavior on cancellation: - HTTP/1: dropping closes the underlying connection (no in-protocol per-request abort) - HTTP/2: dropping resets the stream with RST_STREAM (CANCEL); shared connection stays usable for other in-flight and future requests Also adds a brief crate-level Cancel safety section pointing readers at the per-future docs, per seanmonstar suggestion in the issue. Refs hyperium#4054
This file contains hidden or 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
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.
Summary
Refs #4054. Documents hyper's cancellation behavior on the two client
send_requestfutures, plus a small crate-level pointer.Per seanmonstar's suggestion in the issue:
This PR does both.
Changes
src/client/conn/http1.rs— adds# Cancel safetytoSendRequest::send_request:src/client/conn/http2.rs— adds# Cancel safetytoSendRequest::send_request:src/lib.rs— brief crate-level mention pointing at the per-future docs.Notes
cargo docruns without--features client.