| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/hyper-0.14.26/src/upgrade.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>upgrade.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../hyper/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../hyper/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! HTTP Upgrades |
| //! |
| //! This module deals with managing [HTTP Upgrades][mdn] 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: |
| //! |
| //! - HTTP/1.1 Upgrades |
| //! - HTTP `CONNECT` |
| //! |
| //! 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 [`on`][] to grab a `Future` which will resolve to the upgraded |
| //! connection object, or an error if the upgrade fails. |
| //! |
| //! [mdn]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Protocol_upgrade_mechanism |
| //! |
| //! # Client |
| //! |
| //! Sending an HTTP upgrade from the [`client`](super::client) involves setting |
| //! either the appropriate method, if wanting to `CONNECT`, or headers such as |
| //! `Upgrade` and `Connection`, on the `http::Request`. Once receiving the |
| //! `http::Response` back, you must check for the specific information that the |
| //! upgrade is agreed upon by the server (such as a `101` status code), and then |
| //! get the `Future` from the `Response`. |
| //! |
| //! # Server |
| //! |
| //! Receiving upgrade requests in a server requires you to check the relevant |
| //! headers in a `Request`, 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 `on()` with the `Request`, and then can spawn a task |
| //! awaiting it. |
| //! |
| //! # Example |
| //! |
| //! See [this example][example] showing how upgrades work with both |
| //! Clients and Servers. |
| //! |
| //! [example]: https://github.com/hyperium/hyper/blob/master/examples/upgrades.rs |
| |
| </span><span class="kw">use </span>std::any::TypeId; |
| <span class="kw">use </span>std::error::Error <span class="kw">as </span>StdError; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::marker::Unpin; |
| |
| <span class="kw">use </span>bytes::Bytes; |
| <span class="kw">use </span>tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; |
| <span class="kw">use </span>tokio::sync::oneshot; |
| <span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"http2"</span>))] |
| </span><span class="kw">use </span>tracing::trace; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::common::io::Rewind; |
| <span class="kw">use </span><span class="kw">crate</span>::common::{task, Future, Pin, Poll}; |
| |
| <span class="doccomment">/// An upgraded HTTP connection. |
| /// |
| /// This type holds a trait object internally of the original IO that |
| /// was used to speak HTTP before the upgrade. It can be used directly |
| /// as a `Read` or `Write` for convenience. |
| /// |
| /// Alternatively, if the exact type is known, this can be deconstructed |
| /// into its parts. |
| </span><span class="kw">pub struct </span>Upgraded { |
| io: Rewind<Box<<span class="kw">dyn </span>Io + Send>>, |
| } |
| |
| <span class="doccomment">/// A future for a possible HTTP upgrade. |
| /// |
| /// If no upgrade was available, or it doesn't succeed, yields an `Error`. |
| </span><span class="kw">pub struct </span>OnUpgrade { |
| rx: <span class="prelude-ty">Option</span><oneshot::Receiver<<span class="kw">crate</span>::Result<Upgraded>>>, |
| } |
| |
| <span class="doccomment">/// The deconstructed parts of an [`Upgraded`](Upgraded) type. |
| /// |
| /// Includes the original IO type, and a read buffer of bytes that the |
| /// HTTP state machine may have already read before completing an upgrade. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Parts<T> { |
| <span class="doccomment">/// The original IO object used before the upgrade. |
| </span><span class="kw">pub </span>io: T, |
| <span class="doccomment">/// A buffer of bytes that have been read but not processed as HTTP. |
| /// |
| /// For instance, if the `Connection` is used for an HTTP upgrade request, |
| /// it is possible the server sent back the first bytes of the new protocol |
| /// along with the response upgrade. |
| /// |
| /// You will want to check for any existing bytes if you plan to continue |
| /// communicating on the IO object. |
| </span><span class="kw">pub </span>read_buf: Bytes, |
| _inner: (), |
| } |
| |
| <span class="doccomment">/// Gets a pending HTTP upgrade from this message. |
| /// |
| /// This can be called on the following types: |
| /// |
| /// - `http::Request<B>` |
| /// - `http::Response<B>` |
| /// - `&mut http::Request<B>` |
| /// - `&mut http::Response<B>` |
| </span><span class="kw">pub fn </span>on<T: sealed::CanUpgrade>(msg: T) -> OnUpgrade { |
| msg.on_upgrade() |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"http2"</span>))] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Pending { |
| tx: oneshot::Sender<<span class="kw">crate</span>::Result<Upgraded>>, |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"http2"</span>))] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>pending() -> (Pending, OnUpgrade) { |
| <span class="kw">let </span>(tx, rx) = oneshot::channel(); |
| (Pending { tx }, OnUpgrade { rx: <span class="prelude-val">Some</span>(rx) }) |
| } |
| |
| <span class="comment">// ===== impl Upgraded ===== |
| |
| </span><span class="kw">impl </span>Upgraded { |
| <span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"http2"</span>, test))] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new<T>(io: T, read_buf: Bytes) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>T: AsyncRead + AsyncWrite + Unpin + Send + <span class="lifetime">'static</span>, |
| { |
| Upgraded { |
| io: Rewind::new_buffered(Box::new(io), read_buf), |
| } |
| } |
| |
| <span class="doccomment">/// Tries to downcast the internal trait object to the type passed. |
| /// |
| /// On success, returns the downcasted parts. On error, returns the |
| /// `Upgraded` back. |
| </span><span class="kw">pub fn </span>downcast<T: AsyncRead + AsyncWrite + Unpin + <span class="lifetime">'static</span>>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><Parts<T>, <span class="self">Self</span>> { |
| <span class="kw">let </span>(io, buf) = <span class="self">self</span>.io.into_inner(); |
| <span class="kw">match </span>io.__hyper_downcast() { |
| <span class="prelude-val">Ok</span>(t) => <span class="prelude-val">Ok</span>(Parts { |
| io: <span class="kw-2">*</span>t, |
| read_buf: buf, |
| _inner: (), |
| }), |
| <span class="prelude-val">Err</span>(io) => <span class="prelude-val">Err</span>(Upgraded { |
| io: Rewind::new_buffered(io, buf), |
| }), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncRead <span class="kw">for </span>Upgraded { |
| <span class="kw">fn </span>poll_read( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&mut </span>ReadBuf<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<()>> { |
| Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.io).poll_read(cx, buf) |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncWrite <span class="kw">for </span>Upgraded { |
| <span class="kw">fn </span>poll_write( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&</span>[u8], |
| ) -> Poll<io::Result<usize>> { |
| Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.io).poll_write(cx, buf) |
| } |
| |
| <span class="kw">fn </span>poll_write_vectored( |
| <span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| bufs: <span class="kw-2">&</span>[io::IoSlice<<span class="lifetime">'_</span>>], |
| ) -> Poll<io::Result<usize>> { |
| Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.io).poll_write_vectored(cx, bufs) |
| } |
| |
| <span class="kw">fn </span>poll_flush(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.io).poll_flush(cx) |
| } |
| |
| <span class="kw">fn </span>poll_shutdown(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| Pin::new(<span class="kw-2">&mut </span><span class="self">self</span>.io).poll_shutdown(cx) |
| } |
| |
| <span class="kw">fn </span>is_write_vectored(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.io.is_write_vectored() |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Upgraded { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_struct(<span class="string">"Upgraded"</span>).finish() |
| } |
| } |
| |
| <span class="comment">// ===== impl OnUpgrade ===== |
| |
| </span><span class="kw">impl </span>OnUpgrade { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>none() -> <span class="self">Self </span>{ |
| OnUpgrade { rx: <span class="prelude-val">None </span>} |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http1"</span>)] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>is_none(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.rx.is_none() |
| } |
| } |
| |
| <span class="kw">impl </span>Future <span class="kw">for </span>OnUpgrade { |
| <span class="kw">type </span>Output = <span class="prelude-ty">Result</span><Upgraded, <span class="kw">crate</span>::Error>; |
| |
| <span class="kw">fn </span>poll(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<<span class="self">Self</span>::Output> { |
| <span class="kw">match </span><span class="self">self</span>.rx { |
| <span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>rx) => Pin::new(rx).poll(cx).map(|res| <span class="kw">match </span>res { |
| <span class="prelude-val">Ok</span>(<span class="prelude-val">Ok</span>(upgraded)) => <span class="prelude-val">Ok</span>(upgraded), |
| <span class="prelude-val">Ok</span>(<span class="prelude-val">Err</span>(err)) => <span class="prelude-val">Err</span>(err), |
| <span class="prelude-val">Err</span>(_oneshot_canceled) => <span class="prelude-val">Err</span>(<span class="kw">crate</span>::Error::new_canceled().with(UpgradeExpected)), |
| }), |
| <span class="prelude-val">None </span>=> Poll::Ready(<span class="prelude-val">Err</span>(<span class="kw">crate</span>::Error::new_user_no_upgrade())), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>OnUpgrade { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_struct(<span class="string">"OnUpgrade"</span>).finish() |
| } |
| } |
| |
| <span class="comment">// ===== impl Pending ===== |
| |
| </span><span class="attribute">#[cfg(any(feature = <span class="string">"http1"</span>, feature = <span class="string">"http2"</span>))] |
| </span><span class="kw">impl </span>Pending { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>fulfill(<span class="self">self</span>, upgraded: Upgraded) { |
| <span class="macro">trace!</span>(<span class="string">"pending upgrade fulfill"</span>); |
| <span class="kw">let _ </span>= <span class="self">self</span>.tx.send(<span class="prelude-val">Ok</span>(upgraded)); |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"http1"</span>)] |
| </span><span class="doccomment">/// Don't fulfill the pending Upgrade, but instead signal that |
| /// upgrades are handled manually. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>manual(<span class="self">self</span>) { |
| <span class="macro">trace!</span>(<span class="string">"pending upgrade handled manually"</span>); |
| <span class="kw">let _ </span>= <span class="self">self</span>.tx.send(<span class="prelude-val">Err</span>(<span class="kw">crate</span>::Error::new_user_manual_upgrade())); |
| } |
| } |
| |
| <span class="comment">// ===== impl UpgradeExpected ===== |
| |
| </span><span class="doccomment">/// Error cause returned when an upgrade was expected but canceled |
| /// for whatever reason. |
| /// |
| /// This likely means the actual `Conn` future wasn't polled and upgraded. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">struct </span>UpgradeExpected; |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>UpgradeExpected { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.write_str(<span class="string">"upgrade expected but not completed"</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>StdError <span class="kw">for </span>UpgradeExpected {} |
| |
| <span class="comment">// ===== impl Io ===== |
| |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">trait </span>Io: AsyncRead + AsyncWrite + Unpin + <span class="lifetime">'static </span>{ |
| <span class="kw">fn </span>__hyper_type_id(<span class="kw-2">&</span><span class="self">self</span>) -> TypeId { |
| TypeId::of::<<span class="self">Self</span>>() |
| } |
| } |
| |
| <span class="kw">impl</span><T: AsyncRead + AsyncWrite + Unpin + <span class="lifetime">'static</span>> Io <span class="kw">for </span>T {} |
| |
| <span class="kw">impl dyn </span>Io + Send { |
| <span class="kw">fn </span>__hyper_is<T: Io>(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">let </span>t = TypeId::of::<T>(); |
| <span class="self">self</span>.__hyper_type_id() == t |
| } |
| |
| <span class="kw">fn </span>__hyper_downcast<T: Io>(<span class="self">self</span>: Box<<span class="self">Self</span>>) -> <span class="prelude-ty">Result</span><Box<T>, Box<<span class="self">Self</span>>> { |
| <span class="kw">if </span><span class="self">self</span>.__hyper_is::<T>() { |
| <span class="comment">// Taken from `std::error::Error::downcast()`. |
| </span><span class="kw">unsafe </span>{ |
| <span class="kw">let </span>raw: <span class="kw-2">*mut </span><span class="kw">dyn </span>Io = Box::into_raw(<span class="self">self</span>); |
| <span class="prelude-val">Ok</span>(Box::from_raw(raw <span class="kw">as </span><span class="kw-2">*mut </span>T)) |
| } |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Err</span>(<span class="self">self</span>) |
| } |
| } |
| } |
| |
| <span class="kw">mod </span>sealed { |
| <span class="kw">use </span><span class="kw">super</span>::OnUpgrade; |
| |
| <span class="kw">pub trait </span>CanUpgrade { |
| <span class="kw">fn </span>on_upgrade(<span class="self">self</span>) -> OnUpgrade; |
| } |
| |
| <span class="kw">impl</span><B> CanUpgrade <span class="kw">for </span>http::Request<B> { |
| <span class="kw">fn </span>on_upgrade(<span class="kw-2">mut </span><span class="self">self</span>) -> OnUpgrade { |
| <span class="self">self</span>.extensions_mut() |
| .remove::<OnUpgrade>() |
| .unwrap_or_else(OnUpgrade::none) |
| } |
| } |
| |
| <span class="kw">impl</span><B> CanUpgrade <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'_ </span><span class="kw-2">mut </span>http::Request<B> { |
| <span class="kw">fn </span>on_upgrade(<span class="self">self</span>) -> OnUpgrade { |
| <span class="self">self</span>.extensions_mut() |
| .remove::<OnUpgrade>() |
| .unwrap_or_else(OnUpgrade::none) |
| } |
| } |
| |
| <span class="kw">impl</span><B> CanUpgrade <span class="kw">for </span>http::Response<B> { |
| <span class="kw">fn </span>on_upgrade(<span class="kw-2">mut </span><span class="self">self</span>) -> OnUpgrade { |
| <span class="self">self</span>.extensions_mut() |
| .remove::<OnUpgrade>() |
| .unwrap_or_else(OnUpgrade::none) |
| } |
| } |
| |
| <span class="kw">impl</span><B> CanUpgrade <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'_ </span><span class="kw-2">mut </span>http::Response<B> { |
| <span class="kw">fn </span>on_upgrade(<span class="self">self</span>) -> OnUpgrade { |
| <span class="self">self</span>.extensions_mut() |
| .remove::<OnUpgrade>() |
| .unwrap_or_else(OnUpgrade::none) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>upgraded_downcast() { |
| <span class="kw">let </span>upgraded = Upgraded::new(Mock, Bytes::new()); |
| |
| <span class="kw">let </span>upgraded = upgraded.downcast::<std::io::Cursor<Vec<u8>>>().unwrap_err(); |
| |
| upgraded.downcast::<Mock>().unwrap(); |
| } |
| |
| <span class="comment">// TODO: replace with tokio_test::io when it can test write_buf |
| </span><span class="kw">struct </span>Mock; |
| |
| <span class="kw">impl </span>AsyncRead <span class="kw">for </span>Mock { |
| <span class="kw">fn </span>poll_read( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| _cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| _buf: <span class="kw-2">&mut </span>ReadBuf<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<()>> { |
| <span class="macro">unreachable!</span>(<span class="string">"Mock::poll_read"</span>) |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncWrite <span class="kw">for </span>Mock { |
| <span class="kw">fn </span>poll_write( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| <span class="kw">_</span>: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&</span>[u8], |
| ) -> Poll<io::Result<usize>> { |
| <span class="comment">// panic!("poll_write shouldn't be called"); |
| </span>Poll::Ready(<span class="prelude-val">Ok</span>(buf.len())) |
| } |
| |
| <span class="kw">fn </span>poll_flush(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, _cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| <span class="macro">unreachable!</span>(<span class="string">"Mock::poll_flush"</span>) |
| } |
| |
| <span class="kw">fn </span>poll_shutdown( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| _cx: <span class="kw-2">&mut </span>task::Context<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<()>> { |
| <span class="macro">unreachable!</span>(<span class="string">"Mock::poll_shutdown"</span>) |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hyper" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
