blob: 88b6229de5aaafcc70eed4c4d42fce8509b05cc9 [file] [log] [blame]
<!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/client/dispatch.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>dispatch.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>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
</pre><pre class="rust"><code><span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">use </span>std::future::Future;
<span class="kw">use </span>futures_util::FutureExt;
<span class="kw">use </span>tokio::sync::{mpsc, oneshot};
<span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::common::Pin;
<span class="kw">use </span><span class="kw">crate</span>::common::{task, Poll};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>RetryPromise&lt;T, U&gt; = oneshot::Receiver&lt;<span class="prelude-ty">Result</span>&lt;U, (<span class="kw">crate</span>::Error, <span class="prelude-ty">Option</span>&lt;T&gt;)&gt;&gt;;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">type </span>Promise&lt;T&gt; = oneshot::Receiver&lt;<span class="prelude-ty">Result</span>&lt;T, <span class="kw">crate</span>::Error&gt;&gt;;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>channel&lt;T, U&gt;() -&gt; (Sender&lt;T, U&gt;, Receiver&lt;T, U&gt;) {
<span class="kw">let </span>(tx, rx) = mpsc::unbounded_channel();
<span class="kw">let </span>(giver, taker) = want::new();
<span class="kw">let </span>tx = Sender {
buffered_once: <span class="bool-val">false</span>,
giver,
inner: tx,
};
<span class="kw">let </span>rx = Receiver { inner: rx, taker };
(tx, rx)
}
<span class="doccomment">/// A bounded sender of requests and callbacks for when responses are ready.
///
/// While the inner sender is unbounded, the Giver is used to determine
/// if the Receiver is ready for another request.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Sender&lt;T, U&gt; {
<span class="doccomment">/// One message is always allowed, even if the Receiver hasn&#39;t asked
/// for it yet. This boolean keeps track of whether we&#39;ve sent one
/// without notice.
</span>buffered_once: bool,
<span class="doccomment">/// The Giver helps watch that the the Receiver side has been polled
/// when the queue is empty. This helps us know when a request and
/// response have been fully processed, and a connection is ready
/// for more.
</span>giver: want::Giver,
<span class="doccomment">/// Actually bounded by the Giver, plus `buffered_once`.
</span>inner: mpsc::UnboundedSender&lt;Envelope&lt;T, U&gt;&gt;,
}
<span class="doccomment">/// An unbounded version.
///
/// Cannot poll the Giver, but can still use it to determine if the Receiver
/// has been dropped. However, this version can be cloned.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>UnboundedSender&lt;T, U&gt; {
<span class="doccomment">/// Only used for `is_closed`, since mpsc::UnboundedSender cannot be checked.
</span>giver: want::SharedGiver,
inner: mpsc::UnboundedSender&lt;Envelope&lt;T, U&gt;&gt;,
}
<span class="kw">impl</span>&lt;T, U&gt; Sender&lt;T, U&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>poll_ready(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cx: <span class="kw-2">&amp;mut </span>task::Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="kw">crate</span>::Result&lt;()&gt;&gt; {
<span class="self">self</span>.giver
.poll_want(cx)
.map_err(|<span class="kw">_</span>| <span class="kw">crate</span>::Error::new_closed())
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_ready(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.giver.is_wanting()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_closed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.giver.is_canceled()
}
<span class="kw">fn </span>can_send(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; bool {
<span class="kw">if </span><span class="self">self</span>.giver.give() || !<span class="self">self</span>.buffered_once {
<span class="comment">// If the receiver is ready *now*, then of course we can send.
//
// If the receiver isn&#39;t ready yet, but we don&#39;t have anything
// in the channel yet, then allow one message.
</span><span class="self">self</span>.buffered_once = <span class="bool-val">true</span>;
<span class="bool-val">true
</span>} <span class="kw">else </span>{
<span class="bool-val">false
</span>}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>try_send(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: T) -&gt; <span class="prelude-ty">Result</span>&lt;RetryPromise&lt;T, U&gt;, T&gt; {
<span class="kw">if </span>!<span class="self">self</span>.can_send() {
<span class="kw">return </span><span class="prelude-val">Err</span>(val);
}
<span class="kw">let </span>(tx, rx) = oneshot::channel();
<span class="self">self</span>.inner
.send(Envelope(<span class="prelude-val">Some</span>((val, Callback::Retry(<span class="prelude-val">Some</span>(tx))))))
.map(<span class="kw">move </span>|<span class="kw">_</span>| rx)
.map_err(|<span class="kw-2">mut </span>e| (e.<span class="number">0</span>).<span class="number">0</span>.take().expect(<span class="string">&quot;envelope not dropped&quot;</span>).<span class="number">0</span>)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>send(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: T) -&gt; <span class="prelude-ty">Result</span>&lt;Promise&lt;U&gt;, T&gt; {
<span class="kw">if </span>!<span class="self">self</span>.can_send() {
<span class="kw">return </span><span class="prelude-val">Err</span>(val);
}
<span class="kw">let </span>(tx, rx) = oneshot::channel();
<span class="self">self</span>.inner
.send(Envelope(<span class="prelude-val">Some</span>((val, Callback::NoRetry(<span class="prelude-val">Some</span>(tx))))))
.map(<span class="kw">move </span>|<span class="kw">_</span>| rx)
.map_err(|<span class="kw-2">mut </span>e| (e.<span class="number">0</span>).<span class="number">0</span>.take().expect(<span class="string">&quot;envelope not dropped&quot;</span>).<span class="number">0</span>)
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>unbound(<span class="self">self</span>) -&gt; UnboundedSender&lt;T, U&gt; {
UnboundedSender {
giver: <span class="self">self</span>.giver.shared(),
inner: <span class="self">self</span>.inner,
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">impl</span>&lt;T, U&gt; UnboundedSender&lt;T, U&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_ready(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
!<span class="self">self</span>.giver.is_canceled()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_closed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.giver.is_canceled()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>try_send(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: T) -&gt; <span class="prelude-ty">Result</span>&lt;RetryPromise&lt;T, U&gt;, T&gt; {
<span class="kw">let </span>(tx, rx) = oneshot::channel();
<span class="self">self</span>.inner
.send(Envelope(<span class="prelude-val">Some</span>((val, Callback::Retry(<span class="prelude-val">Some</span>(tx))))))
.map(<span class="kw">move </span>|<span class="kw">_</span>| rx)
.map_err(|<span class="kw-2">mut </span>e| (e.<span class="number">0</span>).<span class="number">0</span>.take().expect(<span class="string">&quot;envelope not dropped&quot;</span>).<span class="number">0</span>)
}
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;backports&quot;</span>, feature = <span class="string">&quot;http2&quot;</span>))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>send(<span class="kw-2">&amp;mut </span><span class="self">self</span>, val: T) -&gt; <span class="prelude-ty">Result</span>&lt;Promise&lt;U&gt;, T&gt; {
<span class="kw">let </span>(tx, rx) = oneshot::channel();
<span class="self">self</span>.inner
.send(Envelope(<span class="prelude-val">Some</span>((val, Callback::NoRetry(<span class="prelude-val">Some</span>(tx))))))
.map(<span class="kw">move </span>|<span class="kw">_</span>| rx)
.map_err(|<span class="kw-2">mut </span>e| (e.<span class="number">0</span>).<span class="number">0</span>.take().expect(<span class="string">&quot;envelope not dropped&quot;</span>).<span class="number">0</span>)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">impl</span>&lt;T, U&gt; Clone <span class="kw">for </span>UnboundedSender&lt;T, U&gt; {
<span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
UnboundedSender {
giver: <span class="self">self</span>.giver.clone(),
inner: <span class="self">self</span>.inner.clone(),
}
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Receiver&lt;T, U&gt; {
inner: mpsc::UnboundedReceiver&lt;Envelope&lt;T, U&gt;&gt;,
taker: want::Taker,
}
<span class="kw">impl</span>&lt;T, U&gt; Receiver&lt;T, U&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>poll_recv(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
cx: <span class="kw-2">&amp;mut </span>task::Context&lt;<span class="lifetime">&#39;_</span>&gt;,
) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;(T, Callback&lt;T, U&gt;)&gt;&gt; {
<span class="kw">match </span><span class="self">self</span>.inner.poll_recv(cx) {
Poll::Ready(item) =&gt; {
Poll::Ready(item.map(|<span class="kw-2">mut </span>env| env.<span class="number">0</span>.take().expect(<span class="string">&quot;envelope not dropped&quot;</span>)))
}
Poll::Pending =&gt; {
<span class="self">self</span>.taker.want();
Poll::Pending
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;http1&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>close(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.taker.cancel();
<span class="self">self</span>.inner.close();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;http1&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>try_recv(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;(T, Callback&lt;T, U&gt;)&gt; {
<span class="kw">match </span><span class="self">self</span>.inner.recv().now_or_never() {
<span class="prelude-val">Some</span>(<span class="prelude-val">Some</span>(<span class="kw-2">mut </span>env)) =&gt; env.<span class="number">0</span>.take(),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="kw">impl</span>&lt;T, U&gt; Drop <span class="kw">for </span>Receiver&lt;T, U&gt; {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="comment">// Notify the giver about the closure first, before dropping
// the mpsc::Receiver.
</span><span class="self">self</span>.taker.cancel();
}
}
<span class="kw">struct </span>Envelope&lt;T, U&gt;(<span class="prelude-ty">Option</span>&lt;(T, Callback&lt;T, U&gt;)&gt;);
<span class="kw">impl</span>&lt;T, U&gt; Drop <span class="kw">for </span>Envelope&lt;T, U&gt; {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">if let </span><span class="prelude-val">Some</span>((val, cb)) = <span class="self">self</span>.<span class="number">0</span>.take() {
cb.send(<span class="prelude-val">Err</span>((
<span class="kw">crate</span>::Error::new_canceled().with(<span class="string">&quot;connection closed&quot;</span>),
<span class="prelude-val">Some</span>(val),
)));
}
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>Callback&lt;T, U&gt; {
Retry(<span class="prelude-ty">Option</span>&lt;oneshot::Sender&lt;<span class="prelude-ty">Result</span>&lt;U, (<span class="kw">crate</span>::Error, <span class="prelude-ty">Option</span>&lt;T&gt;)&gt;&gt;&gt;),
NoRetry(<span class="prelude-ty">Option</span>&lt;oneshot::Sender&lt;<span class="prelude-ty">Result</span>&lt;U, <span class="kw">crate</span>::Error&gt;&gt;&gt;),
}
<span class="kw">impl</span>&lt;T, U&gt; Drop <span class="kw">for </span>Callback&lt;T, U&gt; {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="comment">// FIXME(nox): What errors do we want here?
</span><span class="kw">let </span>error = <span class="kw">crate</span>::Error::new_user_dispatch_gone().with(<span class="kw">if </span>std::thread::panicking() {
<span class="string">&quot;user code panicked&quot;
</span>} <span class="kw">else </span>{
<span class="string">&quot;runtime dropped the dispatch task&quot;
</span>});
<span class="kw">match </span><span class="self">self </span>{
Callback::Retry(tx) =&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(tx) = tx.take() {
<span class="kw">let _ </span>= tx.send(<span class="prelude-val">Err</span>((error, <span class="prelude-val">None</span>)));
}
}
Callback::NoRetry(tx) =&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(tx) = tx.take() {
<span class="kw">let _ </span>= tx.send(<span class="prelude-val">Err</span>(error));
}
}
}
}
}
<span class="kw">impl</span>&lt;T, U&gt; Callback&lt;T, U&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>is_canceled(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Callback::Retry(<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>tx)) =&gt; tx.is_closed(),
Callback::NoRetry(<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>tx)) =&gt; tx.is_closed(),
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(),
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>poll_canceled(<span class="kw-2">&amp;mut </span><span class="self">self</span>, cx: <span class="kw-2">&amp;mut </span>task::Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;()&gt; {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Callback::Retry(<span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>tx)) =&gt; tx.poll_closed(cx),
Callback::NoRetry(<span class="prelude-val">Some</span>(<span class="kw-2">ref mut </span>tx)) =&gt; tx.poll_closed(cx),
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(),
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>send(<span class="kw-2">mut </span><span class="self">self</span>, val: <span class="prelude-ty">Result</span>&lt;U, (<span class="kw">crate</span>::Error, <span class="prelude-ty">Option</span>&lt;T&gt;)&gt;) {
<span class="kw">match </span><span class="self">self </span>{
Callback::Retry(<span class="kw-2">ref mut </span>tx) =&gt; {
<span class="kw">let _ </span>= tx.take().unwrap().send(val);
}
Callback::NoRetry(<span class="kw-2">ref mut </span>tx) =&gt; {
<span class="kw">let _ </span>= tx.take().unwrap().send(val.map_err(|e| e.<span class="number">0</span>));
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">async fn </span>send_when(
<span class="self">self</span>,
<span class="kw-2">mut </span>when: <span class="kw">impl </span>Future&lt;Output = <span class="prelude-ty">Result</span>&lt;U, (<span class="kw">crate</span>::Error, <span class="prelude-ty">Option</span>&lt;T&gt;)&gt;&gt; + Unpin,
) {
<span class="kw">use </span>futures_util::future;
<span class="kw">use </span>tracing::trace;
<span class="kw">let </span><span class="kw-2">mut </span>cb = <span class="prelude-val">Some</span>(<span class="self">self</span>);
<span class="comment">// &quot;select&quot; on this callback being canceled, and the future completing
</span>future::poll_fn(<span class="kw">move </span>|cx| {
<span class="kw">match </span>Pin::new(<span class="kw-2">&amp;mut </span>when).poll(cx) {
Poll::Ready(<span class="prelude-val">Ok</span>(res)) =&gt; {
cb.take().expect(<span class="string">&quot;polled after complete&quot;</span>).send(<span class="prelude-val">Ok</span>(res));
Poll::Ready(())
}
Poll::Pending =&gt; {
<span class="comment">// check if the callback is canceled
</span><span class="macro">ready!</span>(cb.as_mut().unwrap().poll_canceled(cx));
<span class="macro">trace!</span>(<span class="string">&quot;send_when canceled&quot;</span>);
Poll::Ready(())
}
Poll::Ready(<span class="prelude-val">Err</span>(err)) =&gt; {
cb.take().expect(<span class="string">&quot;polled after complete&quot;</span>).send(<span class="prelude-val">Err</span>(err));
Poll::Ready(())
}
}
})
.<span class="kw">await
</span>}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="attribute">#[cfg(feature = <span class="string">&quot;nightly&quot;</span>)]
</span><span class="kw">extern crate </span>test;
<span class="kw">use </span>std::future::Future;
<span class="kw">use </span>std::pin::Pin;
<span class="kw">use </span>std::task::{Context, Poll};
<span class="kw">use super</span>::{channel, Callback, Receiver};
<span class="attribute">#[derive(Debug)]
</span><span class="kw">struct </span>Custom(i32);
<span class="kw">impl</span>&lt;T, U&gt; Future <span class="kw">for </span>Receiver&lt;T, U&gt; {
<span class="kw">type </span>Output = <span class="prelude-ty">Option</span>&lt;(T, Callback&lt;T, U&gt;)&gt;;
<span class="kw">fn </span>poll(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="self">Self</span>::Output&gt; {
<span class="self">self</span>.poll_recv(cx)
}
}
<span class="doccomment">/// Helper to check if the future is ready after polling once.
</span><span class="kw">struct </span>PollOnce&lt;<span class="lifetime">&#39;a</span>, F&gt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>F);
<span class="kw">impl</span>&lt;F, T&gt; Future <span class="kw">for </span>PollOnce&lt;<span class="lifetime">&#39;_</span>, F&gt;
<span class="kw">where
</span>F: Future&lt;Output = T&gt; + Unpin,
{
<span class="kw">type </span>Output = <span class="prelude-ty">Option</span>&lt;()&gt;;
<span class="kw">fn </span>poll(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="self">Self</span>::Output&gt; {
<span class="kw">match </span>Pin::new(<span class="kw-2">&amp;mut </span><span class="self">self</span>.<span class="number">0</span>).poll(cx) {
Poll::Ready(<span class="kw">_</span>) =&gt; Poll::Ready(<span class="prelude-val">Some</span>(())),
Poll::Pending =&gt; Poll::Ready(<span class="prelude-val">None</span>),
}
}
}
<span class="attribute">#[tokio::test]
</span><span class="kw">async fn </span>drop_receiver_sends_cancel_errors() {
<span class="kw">let _ </span>= pretty_env_logger::try_init();
<span class="kw">let </span>(<span class="kw-2">mut </span>tx, <span class="kw-2">mut </span>rx) = channel::&lt;Custom, ()&gt;();
<span class="comment">// must poll once for try_send to succeed
</span><span class="macro">assert!</span>(PollOnce(<span class="kw-2">&amp;mut </span>rx).<span class="kw">await</span>.is_none(), <span class="string">&quot;rx empty&quot;</span>);
<span class="kw">let </span>promise = tx.try_send(Custom(<span class="number">43</span>)).unwrap();
drop(rx);
<span class="kw">let </span>fulfilled = promise.<span class="kw">await</span>;
<span class="kw">let </span>err = fulfilled
.expect(<span class="string">&quot;fulfilled&quot;</span>)
.expect_err(<span class="string">&quot;promise should error&quot;</span>);
<span class="kw">match </span>(err.<span class="number">0</span>.kind(), err.<span class="number">1</span>) {
(<span class="kw-2">&amp;</span><span class="kw">crate</span>::error::Kind::Canceled, <span class="prelude-val">Some</span>(<span class="kw">_</span>)) =&gt; (),
e =&gt; <span class="macro">panic!</span>(<span class="string">&quot;expected Error::Cancel(_), found {:?}&quot;</span>, e),
}
}
<span class="attribute">#[tokio::test]
</span><span class="kw">async fn </span>sender_checks_for_want_on_send() {
<span class="kw">let </span>(<span class="kw-2">mut </span>tx, <span class="kw-2">mut </span>rx) = channel::&lt;Custom, ()&gt;();
<span class="comment">// one is allowed to buffer, second is rejected
</span><span class="kw">let _ </span>= tx.try_send(Custom(<span class="number">1</span>)).expect(<span class="string">&quot;1 buffered&quot;</span>);
tx.try_send(Custom(<span class="number">2</span>)).expect_err(<span class="string">&quot;2 not ready&quot;</span>);
<span class="macro">assert!</span>(PollOnce(<span class="kw-2">&amp;mut </span>rx).<span class="kw">await</span>.is_some(), <span class="string">&quot;rx once&quot;</span>);
<span class="comment">// Even though 1 has been popped, only 1 could be buffered for the
// lifetime of the channel.
</span>tx.try_send(Custom(<span class="number">2</span>)).expect_err(<span class="string">&quot;2 still not ready&quot;</span>);
<span class="macro">assert!</span>(PollOnce(<span class="kw-2">&amp;mut </span>rx).<span class="kw">await</span>.is_none(), <span class="string">&quot;rx empty&quot;</span>);
<span class="kw">let _ </span>= tx.try_send(Custom(<span class="number">2</span>)).expect(<span class="string">&quot;2 ready&quot;</span>);
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;http2&quot;</span>)]
#[test]
</span><span class="kw">fn </span>unbounded_sender_doesnt_bound_on_want() {
<span class="kw">let </span>(tx, rx) = channel::&lt;Custom, ()&gt;();
<span class="kw">let </span><span class="kw-2">mut </span>tx = tx.unbound();
<span class="kw">let _ </span>= tx.try_send(Custom(<span class="number">1</span>)).unwrap();
<span class="kw">let _ </span>= tx.try_send(Custom(<span class="number">2</span>)).unwrap();
<span class="kw">let _ </span>= tx.try_send(Custom(<span class="number">3</span>)).unwrap();
drop(rx);
<span class="kw">let _ </span>= tx.try_send(Custom(<span class="number">4</span>)).unwrap_err();
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;nightly&quot;</span>)]
#[bench]
</span><span class="kw">fn </span>giver_queue_throughput(b: <span class="kw-2">&amp;mut </span>test::Bencher) {
<span class="kw">use crate</span>::{Body, Request, Response};
<span class="kw">let </span>rt = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.unwrap();
<span class="kw">let </span>(<span class="kw-2">mut </span>tx, <span class="kw-2">mut </span>rx) = channel::&lt;Request&lt;Body&gt;, Response&lt;Body&gt;&gt;();
b.iter(<span class="kw">move </span>|| {
<span class="kw">let _ </span>= tx.send(Request::default()).unwrap();
rt.block_on(<span class="kw">async </span>{
<span class="kw">loop </span>{
<span class="kw">let </span>poll_once = PollOnce(<span class="kw-2">&amp;mut </span>rx);
<span class="kw">let </span>opt = poll_once.<span class="kw">await</span>;
<span class="kw">if </span>opt.is_none() {
<span class="kw">break</span>;
}
}
});
})
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;nightly&quot;</span>)]
#[bench]
</span><span class="kw">fn </span>giver_queue_not_ready(b: <span class="kw-2">&amp;mut </span>test::Bencher) {
<span class="kw">let </span>rt = tokio::runtime::Builder::new_current_thread()
.enable_all()
.build()
.unwrap();
<span class="kw">let </span>(_tx, <span class="kw-2">mut </span>rx) = channel::&lt;i32, ()&gt;();
b.iter(<span class="kw">move </span>|| {
rt.block_on(<span class="kw">async </span>{
<span class="kw">let </span>poll_once = PollOnce(<span class="kw-2">&amp;mut </span>rx);
<span class="macro">assert!</span>(poll_once.<span class="kw">await</span>.is_none());
});
})
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;nightly&quot;</span>)]
#[bench]
</span><span class="kw">fn </span>giver_queue_cancel(b: <span class="kw-2">&amp;mut </span>test::Bencher) {
<span class="kw">let </span>(_tx, <span class="kw-2">mut </span>rx) = channel::&lt;i32, ()&gt;();
b.iter(<span class="kw">move </span>|| {
rx.taker.cancel();
})
}
}
</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>