30 lines
6.2 KiB
HTML
30 lines
6.2 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="HTTP Upgrades"><title>hyper::upgrade - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="hyper" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module upgrade</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../hyper/index.html">hyper</a><span class="version">1.8.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module upgrade</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#client" title="Client">Client</a></li><li><a href="#server" title="Server">Server</a></li><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate hyper</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">hyper</a></div><h1>Module <span>upgrade</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/hyper/upgrade.rs.html#1-407">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>HTTP Upgrades</p>
|
|
<p>This module deals with managing <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Protocol_upgrade_mechanism">HTTP Upgrades</a> in hyper. Since
|
|
several concepts in HTTP allow for first talking HTTP, and then converting
|
|
to a different protocol, this module conflates them into a single API.
|
|
Those include:</p>
|
|
<ul>
|
|
<li>HTTP/1.1 Upgrades</li>
|
|
<li>HTTP <code>CONNECT</code></li>
|
|
</ul>
|
|
<p>You are responsible for any other pre-requisites to establish an upgrade,
|
|
such as sending the appropriate headers, methods, and status codes. You can
|
|
then use <a href="fn.on.html" title="fn hyper::upgrade::on"><code>on</code></a> to grab a <code>Future</code> which will resolve to the upgraded
|
|
connection object, or an error if the upgrade fails.</p>
|
|
<h2 id="client"><a class="doc-anchor" href="#client">§</a>Client</h2>
|
|
<p>Sending an HTTP upgrade from the <a href="../client/index.html" title="mod hyper::client"><code>client</code></a> involves setting
|
|
either the appropriate method, if wanting to <code>CONNECT</code>, or headers such as
|
|
<code>Upgrade</code> and <code>Connection</code>, on the <code>http::Request</code>. Once receiving the
|
|
<code>http::Response</code> back, you must check for the specific information that the
|
|
upgrade is agreed upon by the server (such as a <code>101</code> status code), and then
|
|
get the <code>Future</code> from the <code>Response</code>.</p>
|
|
<h2 id="server"><a class="doc-anchor" href="#server">§</a>Server</h2>
|
|
<p>Receiving upgrade requests in a server requires you to check the relevant
|
|
headers in a <code>Request</code>, and if an upgrade should be done, you then send the
|
|
corresponding headers in a response. To then wait for hyper to finish the
|
|
upgrade, you call <code>on()</code> with the <code>Request</code>, and then can spawn a task
|
|
awaiting it.</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<p>See <a href="https://github.com/hyperium/hyper/blob/master/examples/upgrades.rs">this example</a> showing how upgrades work with both
|
|
Clients and Servers.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.OnUpgrade.html" title="struct hyper::upgrade::OnUpgrade">OnUpgrade</a></dt><dd>A future for a possible HTTP upgrade.</dd><dt><a class="struct" href="struct.Parts.html" title="struct hyper::upgrade::Parts">Parts</a></dt><dd>The deconstructed parts of an <a href="struct.Upgraded.html" title="struct hyper::upgrade::Upgraded"><code>Upgraded</code></a> type.</dd><dt><a class="struct" href="struct.Upgraded.html" title="struct hyper::upgrade::Upgraded">Upgraded</a></dt><dd>An upgraded HTTP connection.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.on.html" title="fn hyper::upgrade::on">on</a></dt><dd>Gets a pending HTTP upgrade from this message.</dd></dl></section></div></main></body></html> |