Closed
Description
Introduced in #1563, the HTTP Upgrade/CONNECT API currently is accessed via hyper::Body::on_upgrade. This has some downsides that I'd like to address with a modified API:
- It makes the
Bodytype fatter. - It requires people keep the
Bodyaround, meaning they can't use stream combinators to read the body first, and then wait for the upgrade to finish. This also makes it more annoying for users who may wish adjust theirhttp::Request<Body>into somehttp::Request<Doodad>.
Proposed API
Similar to the proposal in #1586, the change would be to pass the http::Request or http::Response to a free function.
hyper::upgrade::on(req_or_resp) -> OnUpgrade- We can also allow passing just a mutable reference, thus not consuming the request or response.
- Optional other functions could be added, but not necessary:
has_upgrade, etc.
Implementation Plan
The types would be inserted into the http::Extensions of the request/response (though with a private wrapper type to hide the exact details).
- Add the new
hyper::upgrade::onfunction. - The
Body::on_upgrademethod would become#[deprecated]. - So as to not be a behavioral breaking change, the
OnUpgradewould need to be placed in both theBodyand theExtensions, wrapped in someArc<Lock>that only allows taking it once.
I'd like to in a future release be able to not put it in an Arc<Lock> and place it in the Body, but I'm not sure how that could really be done in 0.13.x. (I knew I'd find something I forgot to change after finally releasing XD).