| <!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/io/util/async_buf_read_ext.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>async_buf_read_ext.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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::io::util::fill_buf::{fill_buf, FillBuf}; |
| <span class="kw">use </span><span class="kw">crate</span>::io::util::lines::{lines, Lines}; |
| <span class="kw">use </span><span class="kw">crate</span>::io::util::read_line::{read_line, ReadLine}; |
| <span class="kw">use </span><span class="kw">crate</span>::io::util::read_until::{read_until, ReadUntil}; |
| <span class="kw">use </span><span class="kw">crate</span>::io::util::split::{split, Split}; |
| <span class="kw">use </span><span class="kw">crate</span>::io::AsyncBufRead; |
| |
| <span class="macro">cfg_io_util! </span>{ |
| <span class="doccomment">/// An extension trait which adds utility methods to [`AsyncBufRead`] types. |
| /// |
| /// [`AsyncBufRead`]: crate::io::AsyncBufRead |
| </span><span class="kw">pub trait </span>AsyncBufReadExt: AsyncBufRead { |
| <span class="doccomment">/// Reads all bytes into `buf` until the delimiter `byte` or EOF is reached. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> io::Result<usize>; |
| /// ``` |
| /// |
| /// This function will read bytes from the underlying stream until the |
| /// delimiter or EOF is found. Once found, all bytes up to, and including, |
| /// the delimiter (if found) will be appended to `buf`. |
| /// |
| /// If successful, this function will return the total number of bytes read. |
| /// |
| /// If this function returns `Ok(0)`, the stream has reached EOF. |
| /// |
| /// # Errors |
| /// |
| /// This function will ignore all instances of [`ErrorKind::Interrupted`] and |
| /// will otherwise return any errors returned by [`fill_buf`]. |
| /// |
| /// If an I/O error is encountered then all bytes read so far will be |
| /// present in `buf` and its length will have been adjusted appropriately. |
| /// |
| /// [`fill_buf`]: AsyncBufRead::poll_fill_buf |
| /// [`ErrorKind::Interrupted`]: std::io::ErrorKind::Interrupted |
| /// |
| /// # Cancel safety |
| /// |
| /// If the method is used as the event in a |
| /// [`tokio::select!`](crate::select) statement and some other branch |
| /// completes first, then some data may have been partially read. Any |
| /// partially read bytes are appended to `buf`, and the method can be |
| /// called again to continue reading until `byte`. |
| /// |
| /// This method returns the total number of bytes read. If you cancel |
| /// the call to `read_until` and then call it again to continue reading, |
| /// the counter is reset. |
| /// |
| /// # Examples |
| /// |
| /// [`std::io::Cursor`][`Cursor`] is a type that implements `BufRead`. In |
| /// this example, we use [`Cursor`] to read all the bytes in a byte slice |
| /// in hyphen delimited segments: |
| /// |
| /// [`Cursor`]: std::io::Cursor |
| /// |
| /// ``` |
| /// use tokio::io::AsyncBufReadExt; |
| /// |
| /// use std::io::Cursor; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let mut cursor = Cursor::new(b"lorem-ipsum"); |
| /// let mut buf = vec![]; |
| /// |
| /// // cursor is at 'l' |
| /// let num_bytes = cursor.read_until(b'-', &mut buf) |
| /// .await |
| /// .expect("reading from cursor won't fail"); |
| /// |
| /// assert_eq!(num_bytes, 6); |
| /// assert_eq!(buf, b"lorem-"); |
| /// buf.clear(); |
| /// |
| /// // cursor is at 'i' |
| /// let num_bytes = cursor.read_until(b'-', &mut buf) |
| /// .await |
| /// .expect("reading from cursor won't fail"); |
| /// |
| /// assert_eq!(num_bytes, 5); |
| /// assert_eq!(buf, b"ipsum"); |
| /// buf.clear(); |
| /// |
| /// // cursor is at EOF |
| /// let num_bytes = cursor.read_until(b'-', &mut buf) |
| /// .await |
| /// .expect("reading from cursor won't fail"); |
| /// assert_eq!(num_bytes, 0); |
| /// assert_eq!(buf, b""); |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>read_until<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>, byte: u8, buf: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Vec<u8>) -> ReadUntil<<span class="lifetime">'a</span>, <span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Unpin, |
| { |
| read_until(<span class="self">self</span>, byte, buf) |
| } |
| |
| <span class="doccomment">/// Reads all bytes until a newline (the 0xA byte) is reached, and append |
| /// them to the provided buffer. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn read_line(&mut self, buf: &mut String) -> io::Result<usize>; |
| /// ``` |
| /// |
| /// This function will read bytes from the underlying stream until the |
| /// newline delimiter (the 0xA byte) or EOF is found. Once found, all bytes |
| /// up to, and including, the delimiter (if found) will be appended to |
| /// `buf`. |
| /// |
| /// If successful, this function will return the total number of bytes read. |
| /// |
| /// If this function returns `Ok(0)`, the stream has reached EOF. |
| /// |
| /// # Errors |
| /// |
| /// This function has the same error semantics as [`read_until`] and will |
| /// also return an error if the read bytes are not valid UTF-8. If an I/O |
| /// error is encountered then `buf` may contain some bytes already read in |
| /// the event that all data read so far was valid UTF-8. |
| /// |
| /// [`read_until`]: AsyncBufReadExt::read_until |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is not cancellation safe. If the method is used as the |
| /// event in a [`tokio::select!`](crate::select) statement and some |
| /// other branch completes first, then some data may have been partially |
| /// read, and this data is lost. There are no guarantees regarding the |
| /// contents of `buf` when the call is cancelled. The current |
| /// implementation replaces `buf` with the empty string, but this may |
| /// change in the future. |
| /// |
| /// This function does not behave like [`read_until`] because of the |
| /// requirement that a string contains only valid utf-8. If you need a |
| /// cancellation safe `read_line`, there are three options: |
| /// |
| /// * Call [`read_until`] with a newline character and manually perform the utf-8 check. |
| /// * The stream returned by [`lines`] has a cancellation safe |
| /// [`next_line`] method. |
| /// * Use [`tokio_util::codec::LinesCodec`][LinesCodec]. |
| /// |
| /// [LinesCodec]: https://docs.rs/tokio-util/0.6/tokio_util/codec/struct.LinesCodec.html |
| /// [`read_until`]: Self::read_until |
| /// [`lines`]: Self::lines |
| /// [`next_line`]: crate::io::Lines::next_line |
| /// |
| /// # Examples |
| /// |
| /// [`std::io::Cursor`][`Cursor`] is a type that implements |
| /// `AsyncBufRead`. In this example, we use [`Cursor`] to read all the |
| /// lines in a byte slice: |
| /// |
| /// [`Cursor`]: std::io::Cursor |
| /// |
| /// ``` |
| /// use tokio::io::AsyncBufReadExt; |
| /// |
| /// use std::io::Cursor; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let mut cursor = Cursor::new(b"foo\nbar"); |
| /// let mut buf = String::new(); |
| /// |
| /// // cursor is at 'f' |
| /// let num_bytes = cursor.read_line(&mut buf) |
| /// .await |
| /// .expect("reading from cursor won't fail"); |
| /// |
| /// assert_eq!(num_bytes, 4); |
| /// assert_eq!(buf, "foo\n"); |
| /// buf.clear(); |
| /// |
| /// // cursor is at 'b' |
| /// let num_bytes = cursor.read_line(&mut buf) |
| /// .await |
| /// .expect("reading from cursor won't fail"); |
| /// |
| /// assert_eq!(num_bytes, 3); |
| /// assert_eq!(buf, "bar"); |
| /// buf.clear(); |
| /// |
| /// // cursor is at EOF |
| /// let num_bytes = cursor.read_line(&mut buf) |
| /// .await |
| /// .expect("reading from cursor won't fail"); |
| /// |
| /// assert_eq!(num_bytes, 0); |
| /// assert_eq!(buf, ""); |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>read_line<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="self">self</span>, buf: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>String) -> ReadLine<<span class="lifetime">'a</span>, <span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Unpin, |
| { |
| read_line(<span class="self">self</span>, buf) |
| } |
| |
| <span class="doccomment">/// Returns a stream of the contents of this reader split on the byte |
| /// `byte`. |
| /// |
| /// This method is the asynchronous equivalent to |
| /// [`BufRead::split`](std::io::BufRead::split). |
| /// |
| /// The stream returned from this function will yield instances of |
| /// [`io::Result`]`<`[`Option`]`<`[`Vec<u8>`]`>>`. Each vector returned will *not* have |
| /// the delimiter byte at the end. |
| /// |
| /// [`io::Result`]: std::io::Result |
| /// [`Option`]: core::option::Option |
| /// [`Vec<u8>`]: std::vec::Vec |
| /// |
| /// # Errors |
| /// |
| /// Each item of the stream has the same error semantics as |
| /// [`AsyncBufReadExt::read_until`](AsyncBufReadExt::read_until). |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # use tokio::io::AsyncBufRead; |
| /// use tokio::io::AsyncBufReadExt; |
| /// |
| /// # async fn dox(my_buf_read: impl AsyncBufRead + Unpin) -> std::io::Result<()> { |
| /// let mut segments = my_buf_read.split(b'f'); |
| /// |
| /// while let Some(segment) = segments.next_segment().await? { |
| /// println!("length = {}", segment.len()) |
| /// } |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>split(<span class="self">self</span>, byte: u8) -> Split<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized + Unpin, |
| { |
| split(<span class="self">self</span>, byte) |
| } |
| |
| <span class="doccomment">/// Returns the contents of the internal buffer, filling it with more |
| /// data from the inner reader if it is empty. |
| /// |
| /// This function is a lower-level call. It needs to be paired with the |
| /// [`consume`] method to function properly. When calling this method, |
| /// none of the contents will be "read" in the sense that later calling |
| /// `read` may return the same contents. As such, [`consume`] must be |
| /// called with the number of bytes that are consumed from this buffer |
| /// to ensure that the bytes are never returned twice. |
| /// |
| /// An empty buffer returned indicates that the stream has reached EOF. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn fill_buf(&mut self) -> io::Result<&[u8]>; |
| /// ``` |
| /// |
| /// # Errors |
| /// |
| /// This function will return an I/O error if the underlying reader was |
| /// read, but returned an error. |
| /// |
| /// [`consume`]: crate::io::AsyncBufReadExt::consume |
| </span><span class="kw">fn </span>fill_buf(<span class="kw-2">&mut </span><span class="self">self</span>) -> FillBuf<<span class="lifetime">'_</span>, <span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Unpin, |
| { |
| fill_buf(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Tells this buffer that `amt` bytes have been consumed from the |
| /// buffer, so they should no longer be returned in calls to [`read`]. |
| /// |
| /// This function is a lower-level call. It needs to be paired with the |
| /// [`fill_buf`] method to function properly. This function does not |
| /// perform any I/O, it simply informs this object that some amount of |
| /// its buffer, returned from [`fill_buf`], has been consumed and should |
| /// no longer be returned. As such, this function may do odd things if |
| /// [`fill_buf`] isn't called before calling it. |
| /// |
| /// The `amt` must be less than the number of bytes in the buffer |
| /// returned by [`fill_buf`]. |
| /// |
| /// [`read`]: crate::io::AsyncReadExt::read |
| /// [`fill_buf`]: crate::io::AsyncBufReadExt::fill_buf |
| </span><span class="kw">fn </span>consume(<span class="kw-2">&mut </span><span class="self">self</span>, amt: usize) |
| <span class="kw">where |
| </span><span class="self">Self</span>: Unpin, |
| { |
| std::pin::Pin::new(<span class="self">self</span>).consume(amt) |
| } |
| |
| <span class="doccomment">/// Returns a stream over the lines of this reader. |
| /// This method is the async equivalent to [`BufRead::lines`](std::io::BufRead::lines). |
| /// |
| /// The stream returned from this function will yield instances of |
| /// [`io::Result`]`<`[`Option`]`<`[`String`]`>>`. Each string returned will *not* have a newline |
| /// byte (the 0xA byte) or CRLF (0xD, 0xA bytes) at the end. |
| /// |
| /// [`io::Result`]: std::io::Result |
| /// [`Option`]: core::option::Option |
| /// [`String`]: String |
| /// |
| /// # Errors |
| /// |
| /// Each line of the stream has the same error semantics as [`AsyncBufReadExt::read_line`]. |
| /// |
| /// # Examples |
| /// |
| /// [`std::io::Cursor`][`Cursor`] is a type that implements `BufRead`. In |
| /// this example, we use [`Cursor`] to iterate over all the lines in a byte |
| /// slice. |
| /// |
| /// [`Cursor`]: std::io::Cursor |
| /// |
| /// ``` |
| /// use tokio::io::AsyncBufReadExt; |
| /// |
| /// use std::io::Cursor; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let cursor = Cursor::new(b"lorem\nipsum\r\ndolor"); |
| /// |
| /// let mut lines = cursor.lines(); |
| /// |
| /// assert_eq!(lines.next_line().await.unwrap(), Some(String::from("lorem"))); |
| /// assert_eq!(lines.next_line().await.unwrap(), Some(String::from("ipsum"))); |
| /// assert_eq!(lines.next_line().await.unwrap(), Some(String::from("dolor"))); |
| /// assert_eq!(lines.next_line().await.unwrap(), None); |
| /// } |
| /// ``` |
| /// |
| /// [`AsyncBufReadExt::read_line`]: AsyncBufReadExt::read_line |
| </span><span class="kw">fn </span>lines(<span class="self">self</span>) -> Lines<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| lines(<span class="self">self</span>) |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><R: AsyncBufRead + <span class="question-mark">?</span>Sized> AsyncBufReadExt <span class="kw">for </span>R {} |
| </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> |
