mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 20:30:52 +01:00
31 lines
7.0 KiB
HTML
31 lines
7.0 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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../hyper/index.html">hyper</a><span class="version">0.14.27</span></h2></div><h2 class="location"><a href="#">Module upgrade</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate hyper</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../hyper/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">hyper</a>::<wbr><a class="mod" href="#">upgrade</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/hyper/upgrade.rs.html#1-382">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></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 href="#client">Client</a></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 href="#server">Server</a></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 href="#example">Example</a></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"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.OnUpgrade.html" title="struct hyper::upgrade::OnUpgrade">OnUpgrade</a></div><div class="desc docblock-short">A future for a possible HTTP upgrade.</div></li><li><div class="item-name"><a class="struct" href="struct.Parts.html" title="struct hyper::upgrade::Parts">Parts</a></div><div class="desc docblock-short">The deconstructed parts of an <a href="struct.Upgraded.html" title="struct hyper::upgrade::Upgraded"><code>Upgraded</code></a> type.</div></li><li><div class="item-name"><a class="struct" href="struct.Upgraded.html" title="struct hyper::upgrade::Upgraded">Upgraded</a></div><div class="desc docblock-short">An upgraded HTTP connection.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.on.html" title="fn hyper::upgrade::on">on</a></div><div class="desc docblock-short">Gets a pending HTTP upgrade from this message.</div></li></ul></section></div></main></body></html> |