| <!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/incubator-teaclave-crates-c8106113f74feefc/ede1f68/mio/src/net/tcp/stream.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>stream.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="../../../../mio/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="../../../../mio/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::io::{<span class="self">self</span>, IoSlice, IoSliceMut, Read, Write}; |
| <span class="kw">use </span>std::net::{<span class="self">self</span>, Shutdown, SocketAddr}; |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">use </span>std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd}; |
| <span class="attribute">#[cfg(target_os = <span class="string">"wasi"</span>)] |
| </span><span class="kw">use </span>std::os::wasi::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd}; |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">use </span>std::os::windows::io::{AsRawSocket, FromRawSocket, IntoRawSocket, RawSocket}; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::io_source::IoSource; |
| <span class="attribute">#[cfg(not(target_os = <span class="string">"wasi"</span>))] |
| </span><span class="kw">use </span><span class="kw">crate</span>::sys::tcp::{connect, new_for_addr}; |
| <span class="kw">use crate</span>::{event, Interest, Registry, Token}; |
| |
| <span class="doccomment">/// A non-blocking TCP stream between a local socket and a remote socket. |
| /// |
| /// The socket will be closed when the value is dropped. |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"os-poll"</span>, doc = <span class="string">"```"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"os-poll"</span>), doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::net::{TcpListener, SocketAddr}; |
| /// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// let address: SocketAddr = "127.0.0.1:0".parse()?; |
| /// let listener = TcpListener::bind(address)?; |
| /// use mio::{Events, Interest, Poll, Token}; |
| /// use mio::net::TcpStream; |
| /// use std::time::Duration; |
| /// |
| /// let mut stream = TcpStream::connect(listener.local_addr()?)?; |
| /// |
| /// let mut poll = Poll::new()?; |
| /// let mut events = Events::with_capacity(128); |
| /// |
| /// // Register the socket with `Poll` |
| /// poll.registry().register(&mut stream, Token(0), Interest::WRITABLE)?; |
| /// |
| /// poll.poll(&mut events, Some(Duration::from_millis(100)))?; |
| /// |
| /// // The socket might be ready at this point |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub struct </span>TcpStream { |
| inner: IoSource<net::TcpStream>, |
| } |
| |
| <span class="kw">impl </span>TcpStream { |
| <span class="doccomment">/// Create a new TCP stream and issue a non-blocking connect to the |
| /// specified address. |
| /// |
| /// # Notes |
| /// |
| /// The returned `TcpStream` may not be connected (and thus usable), unlike |
| /// the API found in `std::net::TcpStream`. Because Mio issues a |
| /// *non-blocking* connect it will not block the thread and instead return |
| /// an unconnected `TcpStream`. |
| /// |
| /// Ensuring the returned stream is connected is surprisingly complex when |
| /// considering cross-platform support. Doing this properly should follow |
| /// the steps below, an example implementation can be found |
| /// [here](https://github.com/Thomasdezeeuw/heph/blob/0c4f1ab3eaf08bea1d65776528bfd6114c9f8374/src/net/tcp/stream.rs#L560-L622). |
| /// |
| /// 1. Call `TcpStream::connect` |
| /// 2. Register the returned stream with at least [write interest]. |
| /// 3. Wait for a (writable) event. |
| /// 4. Check `TcpStream::peer_addr`. If it returns `libc::EINPROGRESS` or |
| /// `ErrorKind::NotConnected` it means the stream is not yet connected, |
| /// go back to step 3. If it returns an address it means the stream is |
| /// connected, go to step 5. If another error is returned something |
| /// went wrong. |
| /// 5. Now the stream can be used. |
| /// |
| /// This may return a `WouldBlock` in which case the socket connection |
| /// cannot be completed immediately, it usually means there are insufficient |
| /// entries in the routing cache. |
| /// |
| /// [write interest]: Interest::WRITABLE |
| </span><span class="attribute">#[cfg(not(target_os = <span class="string">"wasi"</span>))] |
| </span><span class="kw">pub fn </span>connect(addr: SocketAddr) -> io::Result<TcpStream> { |
| <span class="kw">let </span>socket = new_for_addr(addr)<span class="question-mark">?</span>; |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">let </span>stream = <span class="kw">unsafe </span>{ TcpStream::from_raw_fd(socket) }; |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">let </span>stream = <span class="kw">unsafe </span>{ TcpStream::from_raw_socket(socket <span class="kw">as _</span>) }; |
| connect(<span class="kw-2">&</span>stream.inner, addr)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(stream) |
| } |
| |
| <span class="doccomment">/// Creates a new `TcpStream` from a standard `net::TcpStream`. |
| /// |
| /// This function is intended to be used to wrap a TCP stream from the |
| /// standard library in the Mio equivalent. The conversion assumes nothing |
| /// about the underlying stream; it is left up to the user to set it in |
| /// non-blocking mode. |
| /// |
| /// # Note |
| /// |
| /// The TCP stream here will not have `connect` called on it, so it |
| /// should already be connected via some other means (be it manually, or |
| /// the standard library). |
| </span><span class="kw">pub fn </span>from_std(stream: net::TcpStream) -> TcpStream { |
| TcpStream { |
| inner: IoSource::new(stream), |
| } |
| } |
| |
| <span class="doccomment">/// Returns the socket address of the remote peer of this TCP connection. |
| </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 socket address of the local half of this TCP connection. |
| </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="doccomment">/// Shuts down the read, write, or both halves of this connection. |
| /// |
| /// This function will cause all pending and future I/O on the specified |
| /// portions to return immediately with an appropriate value (see the |
| /// documentation of `Shutdown`). |
| </span><span class="kw">pub fn </span>shutdown(<span class="kw-2">&</span><span class="self">self</span>, how: Shutdown) -> io::Result<()> { |
| <span class="self">self</span>.inner.shutdown(how) |
| } |
| |
| <span class="doccomment">/// Sets the value of the `TCP_NODELAY` option on this socket. |
| /// |
| /// If set, this option disables the Nagle algorithm. This means that |
| /// segments are always sent as soon as possible, even if there is only a |
| /// small amount of data. When not set, data is buffered until there is a |
| /// sufficient amount to send out, thereby avoiding the frequent sending of |
| /// small packets. |
| /// |
| /// # Notes |
| /// |
| /// On Windows make sure the stream is connected before calling this method, |
| /// by receiving an (writable) event. Trying to set `nodelay` on an |
| /// unconnected `TcpStream` is unspecified behavior. |
| </span><span class="kw">pub fn </span>set_nodelay(<span class="kw-2">&</span><span class="self">self</span>, nodelay: bool) -> io::Result<()> { |
| <span class="self">self</span>.inner.set_nodelay(nodelay) |
| } |
| |
| <span class="doccomment">/// Gets the value of the `TCP_NODELAY` option on this socket. |
| /// |
| /// For more information about this option, see [`set_nodelay`][link]. |
| /// |
| /// [link]: #method.set_nodelay |
| /// |
| /// # Notes |
| /// |
| /// On Windows make sure the stream is connected before calling this method, |
| /// by receiving an (writable) event. Trying to get `nodelay` on an |
| /// unconnected `TcpStream` is unspecified behavior. |
| </span><span class="kw">pub fn </span>nodelay(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<bool> { |
| <span class="self">self</span>.inner.nodelay() |
| } |
| |
| <span class="doccomment">/// Sets the value for the `IP_TTL` option on this socket. |
| /// |
| /// This value sets the time-to-live field that is used in every packet sent |
| /// from this socket. |
| /// |
| /// # Notes |
| /// |
| /// On Windows make sure the stream is connected before calling this method, |
| /// by receiving an (writable) event. Trying to set `ttl` on an |
| /// unconnected `TcpStream` is unspecified behavior. |
| </span><span class="kw">pub fn </span>set_ttl(<span class="kw-2">&</span><span class="self">self</span>, ttl: u32) -> io::Result<()> { |
| <span class="self">self</span>.inner.set_ttl(ttl) |
| } |
| |
| <span class="doccomment">/// Gets the value of the `IP_TTL` option for this socket. |
| /// |
| /// For more information about this option, see [`set_ttl`][link]. |
| /// |
| /// # Notes |
| /// |
| /// On Windows make sure the stream is connected before calling this method, |
| /// by receiving an (writable) event. Trying to get `ttl` on an |
| /// unconnected `TcpStream` is unspecified behavior. |
| /// |
| /// [link]: #method.set_ttl |
| </span><span class="kw">pub fn </span>ttl(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<u32> { |
| <span class="self">self</span>.inner.ttl() |
| } |
| |
| <span class="doccomment">/// Get the value of the `SO_ERROR` option on this socket. |
| /// |
| /// This will retrieve the stored error in the underlying socket, clearing |
| /// the field in the process. This can be useful for checking errors between |
| /// calls. |
| </span><span class="kw">pub fn </span>take_error(<span class="kw-2">&</span><span class="self">self</span>) -> io::Result<<span class="prelude-ty">Option</span><io::Error>> { |
| <span class="self">self</span>.inner.take_error() |
| } |
| |
| <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. |
| /// |
| /// Successive calls return the same data. This is accomplished by passing |
| /// `MSG_PEEK` as a flag to the underlying recv system call. |
| </span><span class="kw">pub fn </span>peek(<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.peek(buf) |
| } |
| |
| <span class="doccomment">/// Execute an I/O operation ensuring that the socket receives more events |
| /// if it hits a [`WouldBlock`] error. |
| /// |
| /// # Notes |
| /// |
| /// This method is required to be called for **all** I/O operations to |
| /// ensure the user will receive events once the socket is ready again after |
| /// returning a [`WouldBlock`] error. |
| /// |
| /// [`WouldBlock`]: io::ErrorKind::WouldBlock |
| /// |
| /// # Examples |
| /// |
| </span><span class="attribute">#[cfg_attr(unix, doc = <span class="string">"```no_run"</span>)] |
| #[cfg_attr(windows, doc = <span class="string">"```ignore"</span>)] |
| </span><span class="doccomment">/// # use std::error::Error; |
| /// # |
| /// # fn main() -> Result<(), Box<dyn Error>> { |
| /// use std::io; |
| /// #[cfg(unix)] |
| /// use std::os::unix::io::AsRawFd; |
| /// #[cfg(windows)] |
| /// use std::os::windows::io::AsRawSocket; |
| /// use mio::net::TcpStream; |
| /// |
| /// let address = "127.0.0.1:8080".parse().unwrap(); |
| /// let stream = TcpStream::connect(address)?; |
| /// |
| /// // Wait until the stream is readable... |
| /// |
| /// // Read from the stream using a direct libc call, of course the |
| /// // `io::Read` implementation would be easier to use. |
| /// let mut buf = [0; 512]; |
| /// let n = stream.try_io(|| { |
| /// let buf_ptr = &mut buf as *mut _ as *mut _; |
| /// #[cfg(unix)] |
| /// let res = unsafe { libc::recv(stream.as_raw_fd(), buf_ptr, buf.len(), 0) }; |
| /// #[cfg(windows)] |
| /// let res = unsafe { libc::recvfrom(stream.as_raw_socket() as usize, buf_ptr, buf.len() as i32, 0, std::ptr::null_mut(), std::ptr::null_mut()) }; |
| /// if res != -1 { |
| /// Ok(res as usize) |
| /// } else { |
| /// // If EAGAIN or EWOULDBLOCK is set by libc::recv, the closure |
| /// // should return `WouldBlock` error. |
| /// Err(io::Error::last_os_error()) |
| /// } |
| /// })?; |
| /// eprintln!("read {} bytes", n); |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">pub fn </span>try_io<F, T>(<span class="kw-2">&</span><span class="self">self</span>, f: F) -> io::Result<T> |
| <span class="kw">where |
| </span>F: FnOnce() -> io::Result<T>, |
| { |
| <span class="self">self</span>.inner.do_io(|<span class="kw">_</span>| f()) |
| } |
| } |
| |
| <span class="kw">impl </span>Read <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>read(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read(buf)) |
| } |
| |
| <span class="kw">fn </span>read_vectored(<span class="kw-2">&mut </span><span class="self">self</span>, bufs: <span class="kw-2">&mut </span>[IoSliceMut<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read_vectored(bufs)) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Read <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span>TcpStream { |
| <span class="kw">fn </span>read(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read(buf)) |
| } |
| |
| <span class="kw">fn </span>read_vectored(<span class="kw-2">&mut </span><span class="self">self</span>, bufs: <span class="kw-2">&mut </span>[IoSliceMut<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.read_vectored(bufs)) |
| } |
| } |
| |
| <span class="kw">impl </span>Write <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write(buf)) |
| } |
| |
| <span class="kw">fn </span>write_vectored(<span class="kw-2">&mut </span><span class="self">self</span>, bufs: <span class="kw-2">&</span>[IoSlice<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write_vectored(bufs)) |
| } |
| |
| <span class="kw">fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.flush()) |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Write <span class="kw">for </span><span class="kw-2">&</span><span class="lifetime">'a </span>TcpStream { |
| <span class="kw">fn </span>write(<span class="kw-2">&mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span>[u8]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write(buf)) |
| } |
| |
| <span class="kw">fn </span>write_vectored(<span class="kw-2">&mut </span><span class="self">self</span>, bufs: <span class="kw-2">&</span>[IoSlice<<span class="lifetime">'_</span>>]) -> io::Result<usize> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.write_vectored(bufs)) |
| } |
| |
| <span class="kw">fn </span>flush(<span class="kw-2">&mut </span><span class="self">self</span>) -> io::Result<()> { |
| <span class="self">self</span>.inner.do_io(|<span class="kw-2">mut </span>inner| inner.flush()) |
| } |
| } |
| |
| <span class="kw">impl </span>event::Source <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>register( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| registry: <span class="kw-2">&</span>Registry, |
| token: Token, |
| interests: Interest, |
| ) -> io::Result<()> { |
| <span class="self">self</span>.inner.register(registry, token, interests) |
| } |
| |
| <span class="kw">fn </span>reregister( |
| <span class="kw-2">&mut </span><span class="self">self</span>, |
| registry: <span class="kw-2">&</span>Registry, |
| token: Token, |
| interests: Interest, |
| ) -> io::Result<()> { |
| <span class="self">self</span>.inner.reregister(registry, token, interests) |
| } |
| |
| <span class="kw">fn </span>deregister(<span class="kw-2">&mut </span><span class="self">self</span>, registry: <span class="kw-2">&</span>Registry) -> io::Result<()> { |
| <span class="self">self</span>.inner.deregister(registry) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>TcpStream { |
| <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="self">self</span>.inner.fmt(f) |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.into_inner().into_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.as_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(unix)] |
| </span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>TcpStream { |
| <span class="doccomment">/// Converts a `RawFd` to a `TcpStream`. |
| /// |
| /// # Notes |
| /// |
| /// The caller is responsible for ensuring that the socket is in |
| /// non-blocking mode. |
| </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -> TcpStream { |
| TcpStream::from_std(FromRawFd::from_raw_fd(fd)) |
| } |
| } |
| |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">impl </span>IntoRawSocket <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>into_raw_socket(<span class="self">self</span>) -> RawSocket { |
| <span class="self">self</span>.inner.into_inner().into_raw_socket() |
| } |
| } |
| |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">impl </span>AsRawSocket <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>as_raw_socket(<span class="kw-2">&</span><span class="self">self</span>) -> RawSocket { |
| <span class="self">self</span>.inner.as_raw_socket() |
| } |
| } |
| |
| <span class="attribute">#[cfg(windows)] |
| </span><span class="kw">impl </span>FromRawSocket <span class="kw">for </span>TcpStream { |
| <span class="doccomment">/// Converts a `RawSocket` to a `TcpStream`. |
| /// |
| /// # Notes |
| /// |
| /// The caller is responsible for ensuring that the socket is in |
| /// non-blocking mode. |
| </span><span class="kw">unsafe fn </span>from_raw_socket(socket: RawSocket) -> TcpStream { |
| TcpStream::from_std(FromRawSocket::from_raw_socket(socket)) |
| } |
| } |
| |
| <span class="attribute">#[cfg(target_os = <span class="string">"wasi"</span>)] |
| </span><span class="kw">impl </span>IntoRawFd <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>into_raw_fd(<span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.into_inner().into_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(target_os = <span class="string">"wasi"</span>)] |
| </span><span class="kw">impl </span>AsRawFd <span class="kw">for </span>TcpStream { |
| <span class="kw">fn </span>as_raw_fd(<span class="kw-2">&</span><span class="self">self</span>) -> RawFd { |
| <span class="self">self</span>.inner.as_raw_fd() |
| } |
| } |
| |
| <span class="attribute">#[cfg(target_os = <span class="string">"wasi"</span>)] |
| </span><span class="kw">impl </span>FromRawFd <span class="kw">for </span>TcpStream { |
| <span class="doccomment">/// Converts a `RawFd` to a `TcpStream`. |
| /// |
| /// # Notes |
| /// |
| /// The caller is responsible for ensuring that the socket is in |
| /// non-blocking mode. |
| </span><span class="kw">unsafe fn </span>from_raw_fd(fd: RawFd) -> TcpStream { |
| TcpStream::from_std(FromRawFd::from_raw_fd(fd)) |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="mio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
