| <!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/git/checkouts/tokio-377c595163f99a10/dfe252d/tokio/src/net/tcp/split_owned.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>split_owned.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="../../../../tokio/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="../../../../tokio/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> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! `TcpStream` owned split support. |
| //! |
| //! A `TcpStream` can be split into an `OwnedReadHalf` and a `OwnedWriteHalf` |
| //! with the `TcpStream::into_split` method. `OwnedReadHalf` implements |
| //! `AsyncRead` while `OwnedWriteHalf` implements `AsyncWrite`. |
| //! |
| //! Compared to the generic split of `AsyncRead + AsyncWrite`, this specialized |
| //! split has no associated overhead and enforces all invariants at the type |
| //! level. |
| |
| </span><span class="kw">use </span><span class="kw">crate</span>::future::poll_fn; |
| <span class="kw">use </span><span class="kw">crate</span>::io::{AsyncRead, AsyncWrite, Interest, ReadBuf, Ready}; |
| <span class="kw">use </span><span class="kw">crate</span>::net::TcpStream; |
| |
| <span class="kw">use </span>std::error::Error; |
| <span class="kw">use </span>std::net::{Shutdown, SocketAddr}; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::sync::Arc; |
| <span class="kw">use </span>std::task::{Context, Poll}; |
| <span class="kw">use </span>std::{fmt, io}; |
| |
| <span class="macro">cfg_io_util! </span>{ |
| <span class="kw">use </span>bytes::BufMut; |
| } |
| |
| <span class="doccomment">/// Owned read half of a [`TcpStream`], created by [`into_split`]. |
| /// |
| /// Reading from an `OwnedReadHalf` is usually done using the convenience methods found |
| /// on the [`AsyncReadExt`] trait. |
| /// |
| /// [`TcpStream`]: TcpStream |
| /// [`into_split`]: TcpStream::into_split() |
| /// [`AsyncReadExt`]: trait@crate::io::AsyncReadExt |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>OwnedReadHalf { |
| inner: Arc<TcpStream>, |
| } |
| |
| <span class="doccomment">/// Owned write half of a [`TcpStream`], created by [`into_split`]. |
| /// |
| /// Note that in the [`AsyncWrite`] implementation of this type, [`poll_shutdown`] will |
| /// shut down the TCP stream in the write direction. Dropping the write half |
| /// will also shut down the write half of the TCP stream. |
| /// |
| /// Writing to an `OwnedWriteHalf` is usually done using the convenience methods found |
| /// on the [`AsyncWriteExt`] trait. |
| /// |
| /// [`TcpStream`]: TcpStream |
| /// [`into_split`]: TcpStream::into_split() |
| /// [`AsyncWrite`]: trait@crate::io::AsyncWrite |
| /// [`poll_shutdown`]: fn@crate::io::AsyncWrite::poll_shutdown |
| /// [`AsyncWriteExt`]: trait@crate::io::AsyncWriteExt |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>OwnedWriteHalf { |
| inner: Arc<TcpStream>, |
| shutdown_on_drop: bool, |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>split_owned(stream: TcpStream) -> (OwnedReadHalf, OwnedWriteHalf) { |
| <span class="kw">let </span>arc = Arc::new(stream); |
| <span class="kw">let </span>read = OwnedReadHalf { |
| inner: Arc::clone(<span class="kw-2">&</span>arc), |
| }; |
| <span class="kw">let </span>write = OwnedWriteHalf { |
| inner: arc, |
| shutdown_on_drop: <span class="bool-val">true</span>, |
| }; |
| (read, write) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>reunite( |
| read: OwnedReadHalf, |
| write: OwnedWriteHalf, |
| ) -> <span class="prelude-ty">Result</span><TcpStream, ReuniteError> { |
| <span class="kw">if </span>Arc::ptr_eq(<span class="kw-2">&</span>read.inner, <span class="kw-2">&</span>write.inner) { |
| write.forget(); |
| <span class="comment">// This unwrap cannot fail as the api does not allow creating more than two Arcs, |
| // and we just dropped the other half. |
| </span><span class="prelude-val">Ok</span>(Arc::try_unwrap(read.inner).expect(<span class="string">"TcpStream: try_unwrap failed in reunite"</span>)) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Err</span>(ReuniteError(read, write)) |
| } |
| } |
| |
| <span class="doccomment">/// Error indicating that two halves were not from the same socket, and thus could |
| /// not be reunited. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>ReuniteError(<span class="kw">pub </span>OwnedReadHalf, <span class="kw">pub </span>OwnedWriteHalf); |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>ReuniteError { |
| <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 { |
| <span class="macro">write!</span>( |
| f, |
| <span class="string">"tried to reunite halves that are not from the same socket" |
| </span>) |
| } |
| } |
| |
| <span class="kw">impl </span>Error <span class="kw">for </span>ReuniteError {} |
| |
| <span class="kw">impl </span>OwnedReadHalf { |
| <span class="doccomment">/// Attempts to put the two halves of a `TcpStream` back together and |
| /// recover the original socket. Succeeds only if the two halves |
| /// originated from the same call to [`into_split`]. |
| /// |
| /// [`into_split`]: TcpStream::into_split() |
| </span><span class="kw">pub fn </span>reunite(<span class="self">self</span>, other: OwnedWriteHalf) -> <span class="prelude-ty">Result</span><TcpStream, ReuniteError> { |
| reunite(<span class="self">self</span>, other) |
| } |
| |
| <span class="doccomment">/// Attempt to receive data on the socket, without removing that data from |
| /// the queue, registering the current task for wakeup if data is not yet |
| /// available. |
| /// |
| /// Note that on multiple calls to `poll_peek` or `poll_read`, only the |
| /// `Waker` from the `Context` passed to the most recent call is scheduled |
| /// to receive a wakeup. |
| /// |
| /// See the [`TcpStream::poll_peek`] level documentation for more details. |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::io::{self, ReadBuf}; |
| /// use tokio::net::TcpStream; |
| /// |
| /// use futures::future::poll_fn; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> io::Result<()> { |
| /// let stream = TcpStream::connect("127.0.0.1:8000").await?; |
| /// let (mut read_half, _) = stream.into_split(); |
| /// let mut buf = [0; 10]; |
| /// let mut buf = ReadBuf::new(&mut buf); |
| /// |
| /// poll_fn(|cx| { |
| /// read_half.poll_peek(cx, &mut buf) |
| /// }).await?; |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// [`TcpStream::poll_peek`]: TcpStream::poll_peek |
| </span><span class="kw">pub fn </span>poll_peek( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&mut </span>ReadBuf<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<usize>> { |
| <span class="self">self</span>.inner.poll_peek(cx, buf) |
| } |
| |
| <span class="doccomment">/// Receives data on the socket from the remote address to which it is |
| /// connected, without removing that data from the queue. On success, |
| /// returns the number of bytes peeked. |
| /// |
| /// See the [`TcpStream::peek`] level documentation for more details. |
| /// |
| /// [`TcpStream::peek`]: TcpStream::peek |
| /// |
| /// # Examples |
| /// |
| /// ```no_run |
| /// use tokio::net::TcpStream; |
| /// use tokio::io::AsyncReadExt; |
| /// use std::error::Error; |
| /// |
| /// #[tokio::main] |
| /// async fn main() -> Result<(), Box<dyn Error>> { |
| /// // Connect to a peer |
| /// let stream = TcpStream::connect("127.0.0.1:8080").await?; |
| /// let (mut read_half, _) = stream.into_split(); |
| /// |
| /// let mut b1 = [0; 10]; |
| /// let mut b2 = [0; 10]; |
| /// |
| /// // Peek at the data |
| /// let n = read_half.peek(&mut b1).await?; |
| /// |
| /// // Read the data |
| /// assert_eq!(n, read_half.read(&mut b2[..n]).await?); |
| /// assert_eq!(&b1[..n], &b2[..n]); |
| /// |
| /// Ok(()) |
| /// } |
| /// ``` |
| /// |
| /// The [`read`] method is defined on the [`AsyncReadExt`] trait. |
| /// |
| /// [`read`]: fn@crate::io::AsyncReadExt::read |
| /// [`AsyncReadExt`]: trait@crate::io::AsyncReadExt |
| </span><span class="kw">pub async fn </span>peek(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = ReadBuf::new(buf); |
| poll_fn(|cx| <span class="self">self</span>.poll_peek(cx, <span class="kw-2">&mut </span>buf)).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Waits for any of the requested ready states. |
| /// |
| /// This function is usually paired with `try_read()` or `try_write()`. It |
| /// can be used to concurrently read / write to the same socket on a single |
| /// task without splitting the socket. |
| /// |
| /// The function may complete without the socket being ready. This is a |
| /// false-positive and attempting an operation will return with |
| /// `io::ErrorKind::WouldBlock`. The function can also return with an empty |
| /// [`Ready`] set, so you should always check the returned value and possibly |
| /// wait again if the requested states are not set. |
| /// |
| /// This function is equivalent to [`TcpStream::ready`]. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. Once a readiness event occurs, the method |
| /// will continue to return immediately until the readiness event is |
| /// consumed by an attempt to read or write that fails with `WouldBlock` or |
| /// `Poll::Pending`. |
| </span><span class="kw">pub async fn </span>ready(<span class="kw-2">&</span><span class="self">self</span>, interest: Interest) -> io::Result<Ready> { |
| <span class="self">self</span>.inner.ready(interest).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Waits for the socket to become readable. |
| /// |
| /// This function is equivalent to `ready(Interest::READABLE)` and is usually |
| /// paired with `try_read()`. |
| /// |
| /// This function is also equivalent to [`TcpStream::ready`]. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. Once a readiness event occurs, the method |
| /// will continue to return immediately until the readiness event is |
| /// consumed by an attempt to read that fails with `WouldBlock` or |
| /// `Poll::Pending`. |
| </span><span class="kw">pub async fn </span>readable(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.inner.readable().<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Tries to read data from the stream into the provided buffer, returning how |
| /// many bytes were read. |
| /// |
| /// Receives any pending data from the socket but does not wait for new data |
| /// to arrive. On success, returns the number of bytes read. Because |
| /// `try_read()` is non-blocking, the buffer does not have to be stored by |
| /// the async task and can exist entirely on the stack. |
| /// |
| /// Usually, [`readable()`] or [`ready()`] is used with this function. |
| /// |
| /// [`readable()`]: Self::readable() |
| /// [`ready()`]: Self::ready() |
| /// |
| /// # Return |
| /// |
| /// If data is successfully read, `Ok(n)` is returned, where `n` is the |
| /// number of bytes read. If `n` is `0`, then it can indicate one of two scenarios: |
| /// |
| /// 1. The stream's read half is closed and will no longer yield data. |
| /// 2. The specified buffer was 0 bytes in length. |
| /// |
| /// If the stream is not ready to read data, |
| /// `Err(io::ErrorKind::WouldBlock)` is returned. |
| </span><span class="kw">pub fn </span>try_read(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.try_read(buf) |
| } |
| |
| <span class="doccomment">/// Tries to read data from the stream into the provided buffers, returning |
| /// how many bytes were read. |
| /// |
| /// Data is copied to fill each buffer in order, with the final buffer |
| /// written to possibly being only partially filled. This method behaves |
| /// equivalently to a single call to [`try_read()`] with concatenated |
| /// buffers. |
| /// |
| /// Receives any pending data from the socket but does not wait for new data |
| /// to arrive. On success, returns the number of bytes read. Because |
| /// `try_read_vectored()` is non-blocking, the buffer does not have to be |
| /// stored by the async task and can exist entirely on the stack. |
| /// |
| /// Usually, [`readable()`] or [`ready()`] is used with this function. |
| /// |
| /// [`try_read()`]: Self::try_read() |
| /// [`readable()`]: Self::readable() |
| /// [`ready()`]: Self::ready() |
| /// |
| /// # Return |
| /// |
| /// If data is successfully read, `Ok(n)` is returned, where `n` is the |
| /// number of bytes read. `Ok(0)` indicates the stream's read half is closed |
| /// and will no longer yield data. If the stream is not ready to read data |
| /// `Err(io::ErrorKind::WouldBlock)` is returned. |
| </span><span class="kw">pub fn </span>try_read_vectored(<span class="kw-2">&</span><span class="self">self</span>, bufs: <span class="kw-2">&mut </span>[io::IoSliceMut<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.try_read_vectored(bufs) |
| } |
| |
| <span class="macro">cfg_io_util! </span>{ |
| <span class="doccomment">/// Tries to read data from the stream into the provided buffer, advancing the |
| /// buffer's internal cursor, returning how many bytes were read. |
| /// |
| /// Receives any pending data from the socket but does not wait for new data |
| /// to arrive. On success, returns the number of bytes read. Because |
| /// `try_read_buf()` is non-blocking, the buffer does not have to be stored by |
| /// the async task and can exist entirely on the stack. |
| /// |
| /// Usually, [`readable()`] or [`ready()`] is used with this function. |
| /// |
| /// [`readable()`]: Self::readable() |
| /// [`ready()`]: Self::ready() |
| /// |
| /// # Return |
| /// |
| /// If data is successfully read, `Ok(n)` is returned, where `n` is the |
| /// number of bytes read. `Ok(0)` indicates the stream's read half is closed |
| /// and will no longer yield data. If the stream is not ready to read data |
| /// `Err(io::ErrorKind::WouldBlock)` is returned. |
| </span><span class="kw">pub fn </span>try_read_buf<B: BufMut>(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>B) -> io::Result<usize> { |
| <span class="self">self</span>.inner.try_read_buf(buf) |
| } |
| } |
| |
| <span class="doccomment">/// Returns the remote address that this stream is connected to. |
| </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.inner.peer_addr() |
| } |
| |
| <span class="doccomment">/// Returns the local address that this stream is bound to. |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.inner.local_addr() |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncRead <span class="kw">for </span>OwnedReadHalf { |
| <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>Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&mut </span>ReadBuf<<span class="lifetime">'_</span>>, |
| ) -> Poll<io::Result<()>> { |
| <span class="self">self</span>.inner.poll_read_priv(cx, buf) |
| } |
| } |
| |
| <span class="kw">impl </span>OwnedWriteHalf { |
| <span class="doccomment">/// Attempts to put the two halves of a `TcpStream` back together and |
| /// recover the original socket. Succeeds only if the two halves |
| /// originated from the same call to [`into_split`]. |
| /// |
| /// [`into_split`]: TcpStream::into_split() |
| </span><span class="kw">pub fn </span>reunite(<span class="self">self</span>, other: OwnedReadHalf) -> <span class="prelude-ty">Result</span><TcpStream, ReuniteError> { |
| reunite(other, <span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Destroys the write half, but don't close the write half of the stream |
| /// until the read half is dropped. If the read half has already been |
| /// dropped, this closes the stream. |
| </span><span class="kw">pub fn </span>forget(<span class="kw-2">mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.shutdown_on_drop = <span class="bool-val">false</span>; |
| drop(<span class="self">self</span>); |
| } |
| |
| <span class="doccomment">/// Waits for any of the requested ready states. |
| /// |
| /// This function is usually paired with `try_read()` or `try_write()`. It |
| /// can be used to concurrently read / write to the same socket on a single |
| /// task without splitting the socket. |
| /// |
| /// The function may complete without the socket being ready. This is a |
| /// false-positive and attempting an operation will return with |
| /// `io::ErrorKind::WouldBlock`. The function can also return with an empty |
| /// [`Ready`] set, so you should always check the returned value and possibly |
| /// wait again if the requested states are not set. |
| /// |
| /// This function is equivalent to [`TcpStream::ready`]. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. Once a readiness event occurs, the method |
| /// will continue to return immediately until the readiness event is |
| /// consumed by an attempt to read or write that fails with `WouldBlock` or |
| /// `Poll::Pending`. |
| </span><span class="kw">pub async fn </span>ready(<span class="kw-2">&</span><span class="self">self</span>, interest: Interest) -> io::Result<Ready> { |
| <span class="self">self</span>.inner.ready(interest).<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Waits for the socket to become writable. |
| /// |
| /// This function is equivalent to `ready(Interest::WRITABLE)` and is usually |
| /// paired with `try_write()`. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. Once a readiness event occurs, the method |
| /// will continue to return immediately until the readiness event is |
| /// consumed by an attempt to write that fails with `WouldBlock` or |
| /// `Poll::Pending`. |
| </span><span class="kw">pub async fn </span>writable(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.inner.writable().<span class="kw">await |
| </span>} |
| |
| <span class="doccomment">/// Tries to write a buffer to the stream, returning how many bytes were |
| /// written. |
| /// |
| /// The function will attempt to write the entire contents of `buf`, but |
| /// only part of the buffer may be written. |
| /// |
| /// This function is usually paired with `writable()`. |
| /// |
| /// # Return |
| /// |
| /// If data is successfully written, `Ok(n)` is returned, where `n` is the |
| /// number of bytes written. If the stream is not ready to write data, |
| /// `Err(io::ErrorKind::WouldBlock)` is returned. |
| </span><span class="kw">pub fn </span>try_write(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.try_write(buf) |
| } |
| |
| <span class="doccomment">/// Tries to write several buffers to the stream, returning how many bytes |
| /// were written. |
| /// |
| /// Data is written from each buffer in order, with the final buffer read |
| /// from possible being only partially consumed. This method behaves |
| /// equivalently to a single call to [`try_write()`] with concatenated |
| /// buffers. |
| /// |
| /// This function is usually paired with `writable()`. |
| /// |
| /// [`try_write()`]: Self::try_write() |
| /// |
| /// # Return |
| /// |
| /// If data is successfully written, `Ok(n)` is returned, where `n` is the |
| /// number of bytes written. If the stream is not ready to write data, |
| /// `Err(io::ErrorKind::WouldBlock)` is returned. |
| </span><span class="kw">pub fn </span>try_write_vectored(<span class="kw-2">&</span><span class="self">self</span>, bufs: <span class="kw-2">&</span>[io::IoSlice<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.try_write_vectored(bufs) |
| } |
| |
| <span class="doccomment">/// Returns the remote address that this stream is connected to. |
| </span><span class="kw">pub fn </span>peer_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.inner.peer_addr() |
| } |
| |
| <span class="doccomment">/// Returns the local address that this stream is bound to. |
| </span><span class="kw">pub fn </span>local_addr(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<SocketAddr> { |
| <span class="self">self</span>.inner.local_addr() |
| } |
| } |
| |
| <span class="kw">impl </span>Drop <span class="kw">for </span>OwnedWriteHalf { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">if </span><span class="self">self</span>.shutdown_on_drop { |
| <span class="kw">let _ </span>= <span class="self">self</span>.inner.shutdown_std(Shutdown::Write); |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>AsyncWrite <span class="kw">for </span>OwnedWriteHalf { |
| <span class="kw">fn </span>poll_write( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| buf: <span class="kw-2">&</span>[u8], |
| ) -> Poll<io::Result<usize>> { |
| <span class="self">self</span>.inner.poll_write_priv(cx, buf) |
| } |
| |
| <span class="kw">fn </span>poll_write_vectored( |
| <span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, |
| cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>, |
| bufs: <span class="kw-2">&</span>[io::IoSlice<<span class="lifetime">'_</span>>], |
| ) -> Poll<io::Result<usize>> { |
| <span class="self">self</span>.inner.poll_write_vectored_priv(cx, bufs) |
| } |
| |
| <span class="kw">fn </span>is_write_vectored(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.inner.is_write_vectored() |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>poll_flush(<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>Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| <span class="comment">// tcp flush is a no-op |
| </span>Poll::Ready(<span class="prelude-val">Ok</span>(())) |
| } |
| |
| <span class="comment">// `poll_shutdown` on a write half shutdowns the stream in the "write" direction. |
| </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>>, <span class="kw">_</span>: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<io::Result<()>> { |
| <span class="kw">let </span>res = <span class="self">self</span>.inner.shutdown_std(Shutdown::Write); |
| <span class="kw">if </span>res.is_ok() { |
| Pin::into_inner(<span class="self">self</span>).shutdown_on_drop = <span class="bool-val">false</span>; |
| } |
| res.into() |
| } |
| } |
| |
| <span class="kw">impl </span>AsRef<TcpStream> <span class="kw">for </span>OwnedReadHalf { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>TcpStream { |
| <span class="kw-2">&</span><span class="self">self</span>.inner |
| } |
| } |
| |
| <span class="kw">impl </span>AsRef<TcpStream> <span class="kw">for </span>OwnedWriteHalf { |
| <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>TcpStream { |
| <span class="kw-2">&</span><span class="self">self</span>.inner |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
