| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tokio-stream-0.1.14/src/stream_ext.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>stream_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_stream/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_stream/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> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</span> |
| <span id="680">680</span> |
| <span id="681">681</span> |
| <span id="682">682</span> |
| <span id="683">683</span> |
| <span id="684">684</span> |
| <span id="685">685</span> |
| <span id="686">686</span> |
| <span id="687">687</span> |
| <span id="688">688</span> |
| <span id="689">689</span> |
| <span id="690">690</span> |
| <span id="691">691</span> |
| <span id="692">692</span> |
| <span id="693">693</span> |
| <span id="694">694</span> |
| <span id="695">695</span> |
| <span id="696">696</span> |
| <span id="697">697</span> |
| <span id="698">698</span> |
| <span id="699">699</span> |
| <span id="700">700</span> |
| <span id="701">701</span> |
| <span id="702">702</span> |
| <span id="703">703</span> |
| <span id="704">704</span> |
| <span id="705">705</span> |
| <span id="706">706</span> |
| <span id="707">707</span> |
| <span id="708">708</span> |
| <span id="709">709</span> |
| <span id="710">710</span> |
| <span id="711">711</span> |
| <span id="712">712</span> |
| <span id="713">713</span> |
| <span id="714">714</span> |
| <span id="715">715</span> |
| <span id="716">716</span> |
| <span id="717">717</span> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| <span id="829">829</span> |
| <span id="830">830</span> |
| <span id="831">831</span> |
| <span id="832">832</span> |
| <span id="833">833</span> |
| <span id="834">834</span> |
| <span id="835">835</span> |
| <span id="836">836</span> |
| <span id="837">837</span> |
| <span id="838">838</span> |
| <span id="839">839</span> |
| <span id="840">840</span> |
| <span id="841">841</span> |
| <span id="842">842</span> |
| <span id="843">843</span> |
| <span id="844">844</span> |
| <span id="845">845</span> |
| <span id="846">846</span> |
| <span id="847">847</span> |
| <span id="848">848</span> |
| <span id="849">849</span> |
| <span id="850">850</span> |
| <span id="851">851</span> |
| <span id="852">852</span> |
| <span id="853">853</span> |
| <span id="854">854</span> |
| <span id="855">855</span> |
| <span id="856">856</span> |
| <span id="857">857</span> |
| <span id="858">858</span> |
| <span id="859">859</span> |
| <span id="860">860</span> |
| <span id="861">861</span> |
| <span id="862">862</span> |
| <span id="863">863</span> |
| <span id="864">864</span> |
| <span id="865">865</span> |
| <span id="866">866</span> |
| <span id="867">867</span> |
| <span id="868">868</span> |
| <span id="869">869</span> |
| <span id="870">870</span> |
| <span id="871">871</span> |
| <span id="872">872</span> |
| <span id="873">873</span> |
| <span id="874">874</span> |
| <span id="875">875</span> |
| <span id="876">876</span> |
| <span id="877">877</span> |
| <span id="878">878</span> |
| <span id="879">879</span> |
| <span id="880">880</span> |
| <span id="881">881</span> |
| <span id="882">882</span> |
| <span id="883">883</span> |
| <span id="884">884</span> |
| <span id="885">885</span> |
| <span id="886">886</span> |
| <span id="887">887</span> |
| <span id="888">888</span> |
| <span id="889">889</span> |
| <span id="890">890</span> |
| <span id="891">891</span> |
| <span id="892">892</span> |
| <span id="893">893</span> |
| <span id="894">894</span> |
| <span id="895">895</span> |
| <span id="896">896</span> |
| <span id="897">897</span> |
| <span id="898">898</span> |
| <span id="899">899</span> |
| <span id="900">900</span> |
| <span id="901">901</span> |
| <span id="902">902</span> |
| <span id="903">903</span> |
| <span id="904">904</span> |
| <span id="905">905</span> |
| <span id="906">906</span> |
| <span id="907">907</span> |
| <span id="908">908</span> |
| <span id="909">909</span> |
| <span id="910">910</span> |
| <span id="911">911</span> |
| <span id="912">912</span> |
| <span id="913">913</span> |
| <span id="914">914</span> |
| <span id="915">915</span> |
| <span id="916">916</span> |
| <span id="917">917</span> |
| <span id="918">918</span> |
| <span id="919">919</span> |
| <span id="920">920</span> |
| <span id="921">921</span> |
| <span id="922">922</span> |
| <span id="923">923</span> |
| <span id="924">924</span> |
| <span id="925">925</span> |
| <span id="926">926</span> |
| <span id="927">927</span> |
| <span id="928">928</span> |
| <span id="929">929</span> |
| <span id="930">930</span> |
| <span id="931">931</span> |
| <span id="932">932</span> |
| <span id="933">933</span> |
| <span id="934">934</span> |
| <span id="935">935</span> |
| <span id="936">936</span> |
| <span id="937">937</span> |
| <span id="938">938</span> |
| <span id="939">939</span> |
| <span id="940">940</span> |
| <span id="941">941</span> |
| <span id="942">942</span> |
| <span id="943">943</span> |
| <span id="944">944</span> |
| <span id="945">945</span> |
| <span id="946">946</span> |
| <span id="947">947</span> |
| <span id="948">948</span> |
| <span id="949">949</span> |
| <span id="950">950</span> |
| <span id="951">951</span> |
| <span id="952">952</span> |
| <span id="953">953</span> |
| <span id="954">954</span> |
| <span id="955">955</span> |
| <span id="956">956</span> |
| <span id="957">957</span> |
| <span id="958">958</span> |
| <span id="959">959</span> |
| <span id="960">960</span> |
| <span id="961">961</span> |
| <span id="962">962</span> |
| <span id="963">963</span> |
| <span id="964">964</span> |
| <span id="965">965</span> |
| <span id="966">966</span> |
| <span id="967">967</span> |
| <span id="968">968</span> |
| <span id="969">969</span> |
| <span id="970">970</span> |
| <span id="971">971</span> |
| <span id="972">972</span> |
| <span id="973">973</span> |
| <span id="974">974</span> |
| <span id="975">975</span> |
| <span id="976">976</span> |
| <span id="977">977</span> |
| <span id="978">978</span> |
| <span id="979">979</span> |
| <span id="980">980</span> |
| <span id="981">981</span> |
| <span id="982">982</span> |
| <span id="983">983</span> |
| <span id="984">984</span> |
| <span id="985">985</span> |
| <span id="986">986</span> |
| <span id="987">987</span> |
| <span id="988">988</span> |
| <span id="989">989</span> |
| <span id="990">990</span> |
| <span id="991">991</span> |
| <span id="992">992</span> |
| <span id="993">993</span> |
| <span id="994">994</span> |
| <span id="995">995</span> |
| <span id="996">996</span> |
| <span id="997">997</span> |
| <span id="998">998</span> |
| <span id="999">999</span> |
| <span id="1000">1000</span> |
| <span id="1001">1001</span> |
| <span id="1002">1002</span> |
| <span id="1003">1003</span> |
| <span id="1004">1004</span> |
| <span id="1005">1005</span> |
| <span id="1006">1006</span> |
| <span id="1007">1007</span> |
| <span id="1008">1008</span> |
| <span id="1009">1009</span> |
| <span id="1010">1010</span> |
| <span id="1011">1011</span> |
| <span id="1012">1012</span> |
| <span id="1013">1013</span> |
| <span id="1014">1014</span> |
| <span id="1015">1015</span> |
| <span id="1016">1016</span> |
| <span id="1017">1017</span> |
| <span id="1018">1018</span> |
| <span id="1019">1019</span> |
| <span id="1020">1020</span> |
| <span id="1021">1021</span> |
| <span id="1022">1022</span> |
| <span id="1023">1023</span> |
| <span id="1024">1024</span> |
| <span id="1025">1025</span> |
| <span id="1026">1026</span> |
| <span id="1027">1027</span> |
| <span id="1028">1028</span> |
| <span id="1029">1029</span> |
| <span id="1030">1030</span> |
| <span id="1031">1031</span> |
| <span id="1032">1032</span> |
| <span id="1033">1033</span> |
| <span id="1034">1034</span> |
| <span id="1035">1035</span> |
| <span id="1036">1036</span> |
| <span id="1037">1037</span> |
| <span id="1038">1038</span> |
| <span id="1039">1039</span> |
| <span id="1040">1040</span> |
| <span id="1041">1041</span> |
| <span id="1042">1042</span> |
| <span id="1043">1043</span> |
| <span id="1044">1044</span> |
| <span id="1045">1045</span> |
| <span id="1046">1046</span> |
| <span id="1047">1047</span> |
| <span id="1048">1048</span> |
| <span id="1049">1049</span> |
| <span id="1050">1050</span> |
| <span id="1051">1051</span> |
| <span id="1052">1052</span> |
| <span id="1053">1053</span> |
| <span id="1054">1054</span> |
| <span id="1055">1055</span> |
| <span id="1056">1056</span> |
| <span id="1057">1057</span> |
| <span id="1058">1058</span> |
| <span id="1059">1059</span> |
| <span id="1060">1060</span> |
| <span id="1061">1061</span> |
| <span id="1062">1062</span> |
| <span id="1063">1063</span> |
| <span id="1064">1064</span> |
| <span id="1065">1065</span> |
| <span id="1066">1066</span> |
| <span id="1067">1067</span> |
| <span id="1068">1068</span> |
| <span id="1069">1069</span> |
| <span id="1070">1070</span> |
| <span id="1071">1071</span> |
| <span id="1072">1072</span> |
| <span id="1073">1073</span> |
| <span id="1074">1074</span> |
| <span id="1075">1075</span> |
| <span id="1076">1076</span> |
| <span id="1077">1077</span> |
| <span id="1078">1078</span> |
| <span id="1079">1079</span> |
| <span id="1080">1080</span> |
| <span id="1081">1081</span> |
| <span id="1082">1082</span> |
| <span id="1083">1083</span> |
| <span id="1084">1084</span> |
| <span id="1085">1085</span> |
| <span id="1086">1086</span> |
| <span id="1087">1087</span> |
| <span id="1088">1088</span> |
| <span id="1089">1089</span> |
| <span id="1090">1090</span> |
| <span id="1091">1091</span> |
| <span id="1092">1092</span> |
| <span id="1093">1093</span> |
| <span id="1094">1094</span> |
| <span id="1095">1095</span> |
| <span id="1096">1096</span> |
| <span id="1097">1097</span> |
| <span id="1098">1098</span> |
| <span id="1099">1099</span> |
| <span id="1100">1100</span> |
| <span id="1101">1101</span> |
| <span id="1102">1102</span> |
| <span id="1103">1103</span> |
| <span id="1104">1104</span> |
| <span id="1105">1105</span> |
| <span id="1106">1106</span> |
| <span id="1107">1107</span> |
| <span id="1108">1108</span> |
| <span id="1109">1109</span> |
| <span id="1110">1110</span> |
| <span id="1111">1111</span> |
| <span id="1112">1112</span> |
| <span id="1113">1113</span> |
| <span id="1114">1114</span> |
| <span id="1115">1115</span> |
| <span id="1116">1116</span> |
| <span id="1117">1117</span> |
| <span id="1118">1118</span> |
| <span id="1119">1119</span> |
| <span id="1120">1120</span> |
| <span id="1121">1121</span> |
| <span id="1122">1122</span> |
| <span id="1123">1123</span> |
| <span id="1124">1124</span> |
| <span id="1125">1125</span> |
| <span id="1126">1126</span> |
| <span id="1127">1127</span> |
| <span id="1128">1128</span> |
| <span id="1129">1129</span> |
| <span id="1130">1130</span> |
| <span id="1131">1131</span> |
| <span id="1132">1132</span> |
| <span id="1133">1133</span> |
| <span id="1134">1134</span> |
| <span id="1135">1135</span> |
| <span id="1136">1136</span> |
| <span id="1137">1137</span> |
| <span id="1138">1138</span> |
| <span id="1139">1139</span> |
| <span id="1140">1140</span> |
| <span id="1141">1141</span> |
| <span id="1142">1142</span> |
| <span id="1143">1143</span> |
| <span id="1144">1144</span> |
| <span id="1145">1145</span> |
| <span id="1146">1146</span> |
| <span id="1147">1147</span> |
| <span id="1148">1148</span> |
| <span id="1149">1149</span> |
| <span id="1150">1150</span> |
| <span id="1151">1151</span> |
| <span id="1152">1152</span> |
| <span id="1153">1153</span> |
| <span id="1154">1154</span> |
| <span id="1155">1155</span> |
| <span id="1156">1156</span> |
| <span id="1157">1157</span> |
| <span id="1158">1158</span> |
| <span id="1159">1159</span> |
| <span id="1160">1160</span> |
| <span id="1161">1161</span> |
| <span id="1162">1162</span> |
| <span id="1163">1163</span> |
| <span id="1164">1164</span> |
| <span id="1165">1165</span> |
| <span id="1166">1166</span> |
| <span id="1167">1167</span> |
| <span id="1168">1168</span> |
| <span id="1169">1169</span> |
| <span id="1170">1170</span> |
| <span id="1171">1171</span> |
| <span id="1172">1172</span> |
| <span id="1173">1173</span> |
| <span id="1174">1174</span> |
| <span id="1175">1175</span> |
| <span id="1176">1176</span> |
| <span id="1177">1177</span> |
| <span id="1178">1178</span> |
| <span id="1179">1179</span> |
| <span id="1180">1180</span> |
| <span id="1181">1181</span> |
| <span id="1182">1182</span> |
| <span id="1183">1183</span> |
| <span id="1184">1184</span> |
| <span id="1185">1185</span> |
| <span id="1186">1186</span> |
| <span id="1187">1187</span> |
| <span id="1188">1188</span> |
| <span id="1189">1189</span> |
| <span id="1190">1190</span> |
| <span id="1191">1191</span> |
| <span id="1192">1192</span> |
| <span id="1193">1193</span> |
| <span id="1194">1194</span> |
| <span id="1195">1195</span> |
| <span id="1196">1196</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>core::future::Future; |
| <span class="kw">use </span>futures_core::Stream; |
| |
| <span class="kw">mod </span>all; |
| <span class="kw">use </span>all::AllFuture; |
| |
| <span class="kw">mod </span>any; |
| <span class="kw">use </span>any::AnyFuture; |
| |
| <span class="kw">mod </span>chain; |
| <span class="kw">use </span>chain::Chain; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>collect; |
| <span class="kw">use </span>collect::{Collect, FromStream}; |
| |
| <span class="kw">mod </span>filter; |
| <span class="kw">use </span>filter::Filter; |
| |
| <span class="kw">mod </span>filter_map; |
| <span class="kw">use </span>filter_map::FilterMap; |
| |
| <span class="kw">mod </span>fold; |
| <span class="kw">use </span>fold::FoldFuture; |
| |
| <span class="kw">mod </span>fuse; |
| <span class="kw">use </span>fuse::Fuse; |
| |
| <span class="kw">mod </span>map; |
| <span class="kw">use </span>map::Map; |
| |
| <span class="kw">mod </span>map_while; |
| <span class="kw">use </span>map_while::MapWhile; |
| |
| <span class="kw">mod </span>merge; |
| <span class="kw">use </span>merge::Merge; |
| |
| <span class="kw">mod </span>next; |
| <span class="kw">use </span>next::Next; |
| |
| <span class="kw">mod </span>skip; |
| <span class="kw">use </span>skip::Skip; |
| |
| <span class="kw">mod </span>skip_while; |
| <span class="kw">use </span>skip_while::SkipWhile; |
| |
| <span class="kw">mod </span>take; |
| <span class="kw">use </span>take::Take; |
| |
| <span class="kw">mod </span>take_while; |
| <span class="kw">use </span>take_while::TakeWhile; |
| |
| <span class="kw">mod </span>then; |
| <span class="kw">use </span>then::Then; |
| |
| <span class="kw">mod </span>try_next; |
| <span class="kw">use </span>try_next::TryNext; |
| |
| <span class="macro">cfg_time! </span>{ |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>timeout; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>timeout_repeating; |
| <span class="kw">use </span>timeout::Timeout; |
| <span class="kw">use </span>timeout_repeating::TimeoutRepeating; |
| <span class="kw">use </span>tokio::time::{Duration, Interval}; |
| <span class="kw">mod </span>throttle; |
| <span class="kw">use </span>throttle::{throttle, Throttle}; |
| <span class="kw">mod </span>chunks_timeout; |
| <span class="kw">use </span>chunks_timeout::ChunksTimeout; |
| } |
| |
| <span class="doccomment">/// An extension trait for the [`Stream`] trait that provides a variety of |
| /// convenient combinator functions. |
| /// |
| /// Be aware that the `Stream` trait in Tokio is a re-export of the trait found |
| /// in the [futures] crate, however both Tokio and futures provide separate |
| /// `StreamExt` utility traits, and some utilities are only available on one of |
| /// these traits. Click [here][futures-StreamExt] to see the other `StreamExt` |
| /// trait in the futures crate. |
| /// |
| /// If you need utilities from both `StreamExt` traits, you should prefer to |
| /// import one of them, and use the other through the fully qualified call |
| /// syntax. For example: |
| /// ``` |
| /// // import one of the traits: |
| /// use futures::stream::StreamExt; |
| /// # #[tokio::main(flavor = "current_thread")] |
| /// # async fn main() { |
| /// |
| /// let a = tokio_stream::iter(vec![1, 3, 5]); |
| /// let b = tokio_stream::iter(vec![2, 4, 6]); |
| /// |
| /// // use the fully qualified call syntax for the other trait: |
| /// let merged = tokio_stream::StreamExt::merge(a, b); |
| /// |
| /// // use normal call notation for futures::stream::StreamExt::collect |
| /// let output: Vec<_> = merged.collect().await; |
| /// assert_eq!(output, vec![1, 2, 3, 4, 5, 6]); |
| /// # } |
| /// ``` |
| /// |
| /// [`Stream`]: crate::Stream |
| /// [futures]: https://docs.rs/futures |
| /// [futures-StreamExt]: https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html |
| </span><span class="kw">pub trait </span>StreamExt: Stream { |
| <span class="doccomment">/// Consumes and returns the next value in the stream or `None` if the |
| /// stream is finished. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn next(&mut self) -> Option<Self::Item>; |
| /// ``` |
| /// |
| /// Note that because `next` doesn't take ownership over the stream, |
| /// the [`Stream`] type must be [`Unpin`]. If you want to use `next` with a |
| /// [`!Unpin`](Unpin) stream, you'll first have to pin the stream. This can |
| /// be done by boxing the stream using [`Box::pin`] or |
| /// pinning it to the stack using the `pin_mut!` macro from the `pin_utils` |
| /// crate. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. The returned future only |
| /// holds onto a reference to the underlying stream, |
| /// so dropping it will never lose a value. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let mut stream = stream::iter(1..=3); |
| /// |
| /// assert_eq!(stream.next().await, Some(1)); |
| /// assert_eq!(stream.next().await, Some(2)); |
| /// assert_eq!(stream.next().await, Some(3)); |
| /// assert_eq!(stream.next().await, None); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> Next<<span class="lifetime">'_</span>, <span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Unpin, |
| { |
| Next::new(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Consumes and returns the next item in the stream. If an error is |
| /// encountered before the next item, the error is returned instead. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn try_next(&mut self) -> Result<Option<T>, E>; |
| /// ``` |
| /// |
| /// This is similar to the [`next`](StreamExt::next) combinator, |
| /// but returns a [`Result<Option<T>, E>`](Result) rather than |
| /// an [`Option<Result<T, E>>`](Option), making for easy use |
| /// with the [`?`](std::ops::Try) operator. |
| /// |
| /// # Cancel safety |
| /// |
| /// This method is cancel safe. The returned future only |
| /// holds onto a reference to the underlying stream, |
| /// so dropping it will never lose a value. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let mut stream = stream::iter(vec![Ok(1), Ok(2), Err("nope")]); |
| /// |
| /// assert_eq!(stream.try_next().await, Ok(Some(1))); |
| /// assert_eq!(stream.try_next().await, Ok(Some(2))); |
| /// assert_eq!(stream.try_next().await, Err("nope")); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>try_next<T, E>(<span class="kw-2">&mut </span><span class="self">self</span>) -> TryNext<<span class="lifetime">'_</span>, <span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Stream<Item = <span class="prelude-ty">Result</span><T, E>> + Unpin, |
| { |
| TryNext::new(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Maps this stream's items to a different type, returning a new stream of |
| /// the resulting type. |
| /// |
| /// The provided closure is executed over all elements of this stream as |
| /// they are made available. It is executed inline with calls to |
| /// [`poll_next`](Stream::poll_next). |
| /// |
| /// Note that this function consumes the stream passed into it and returns a |
| /// wrapped version of it, similar to the existing `map` methods in the |
| /// standard library. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let stream = stream::iter(1..=3); |
| /// let mut stream = stream.map(|x| x + 3); |
| /// |
| /// assert_eq!(stream.next().await, Some(4)); |
| /// assert_eq!(stream.next().await, Some(5)); |
| /// assert_eq!(stream.next().await, Some(6)); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>map<T, F>(<span class="self">self</span>, f: F) -> Map<<span class="self">Self</span>, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="self">Self</span>::Item) -> T, |
| <span class="self">Self</span>: Sized, |
| { |
| Map::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Map this stream's items to a different type for as long as determined by |
| /// the provided closure. A stream of the target type will be returned, |
| /// which will yield elements until the closure returns `None`. |
| /// |
| /// The provided closure is executed over all elements of this stream as |
| /// they are made available, until it returns `None`. It is executed inline |
| /// with calls to [`poll_next`](Stream::poll_next). Once `None` is returned, |
| /// the underlying stream will not be polled again. |
| /// |
| /// Note that this function consumes the stream passed into it and returns a |
| /// wrapped version of it, similar to the [`Iterator::map_while`] method in the |
| /// standard library. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let stream = stream::iter(1..=10); |
| /// let mut stream = stream.map_while(|x| { |
| /// if x < 4 { |
| /// Some(x + 3) |
| /// } else { |
| /// None |
| /// } |
| /// }); |
| /// assert_eq!(stream.next().await, Some(4)); |
| /// assert_eq!(stream.next().await, Some(5)); |
| /// assert_eq!(stream.next().await, Some(6)); |
| /// assert_eq!(stream.next().await, None); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>map_while<T, F>(<span class="self">self</span>, f: F) -> MapWhile<<span class="self">Self</span>, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="self">Self</span>::Item) -> <span class="prelude-ty">Option</span><T>, |
| <span class="self">Self</span>: Sized, |
| { |
| MapWhile::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Maps this stream's items asynchronously to a different type, returning a |
| /// new stream of the resulting type. |
| /// |
| /// The provided closure is executed over all elements of this stream as |
| /// they are made available, and the returned future is executed. Only one |
| /// future is executed at the time. |
| /// |
| /// Note that this function consumes the stream passed into it and returns a |
| /// wrapped version of it, similar to the existing `then` methods in the |
| /// standard library. |
| /// |
| /// Be aware that if the future is not `Unpin`, then neither is the `Stream` |
| /// returned by this method. To handle this, you can use `tokio::pin!` as in |
| /// the example below or put the stream in a `Box` with `Box::pin(stream)`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// async fn do_async_work(value: i32) -> i32 { |
| /// value + 3 |
| /// } |
| /// |
| /// let stream = stream::iter(1..=3); |
| /// let stream = stream.then(do_async_work); |
| /// |
| /// tokio::pin!(stream); |
| /// |
| /// assert_eq!(stream.next().await, Some(4)); |
| /// assert_eq!(stream.next().await, Some(5)); |
| /// assert_eq!(stream.next().await, Some(6)); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>then<F, Fut>(<span class="self">self</span>, f: F) -> Then<<span class="self">Self</span>, Fut, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="self">Self</span>::Item) -> Fut, |
| Fut: Future, |
| <span class="self">Self</span>: Sized, |
| { |
| Then::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Combine two streams into one by interleaving the output of both as it |
| /// is produced. |
| /// |
| /// Values are produced from the merged stream in the order they arrive from |
| /// the two source streams. If both source streams provide values |
| /// simultaneously, the merge stream alternates between them. This provides |
| /// some level of fairness. You should not chain calls to `merge`, as this |
| /// will break the fairness of the merging. |
| /// |
| /// The merged stream completes once **both** source streams complete. When |
| /// one source stream completes before the other, the merge stream |
| /// exclusively polls the remaining stream. |
| /// |
| /// For merging multiple streams, consider using [`StreamMap`] instead. |
| /// |
| /// [`StreamMap`]: crate::StreamMap |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio_stream::{StreamExt, Stream}; |
| /// use tokio::sync::mpsc; |
| /// use tokio::time; |
| /// |
| /// use std::time::Duration; |
| /// use std::pin::Pin; |
| /// |
| /// # /* |
| /// #[tokio::main] |
| /// # */ |
| /// # #[tokio::main(flavor = "current_thread")] |
| /// async fn main() { |
| /// # time::pause(); |
| /// let (tx1, mut rx1) = mpsc::channel::<usize>(10); |
| /// let (tx2, mut rx2) = mpsc::channel::<usize>(10); |
| /// |
| /// // Convert the channels to a `Stream`. |
| /// let rx1 = Box::pin(async_stream::stream! { |
| /// while let Some(item) = rx1.recv().await { |
| /// yield item; |
| /// } |
| /// }) as Pin<Box<dyn Stream<Item = usize> + Send>>; |
| /// |
| /// let rx2 = Box::pin(async_stream::stream! { |
| /// while let Some(item) = rx2.recv().await { |
| /// yield item; |
| /// } |
| /// }) as Pin<Box<dyn Stream<Item = usize> + Send>>; |
| /// |
| /// let mut rx = rx1.merge(rx2); |
| /// |
| /// tokio::spawn(async move { |
| /// // Send some values immediately |
| /// tx1.send(1).await.unwrap(); |
| /// tx1.send(2).await.unwrap(); |
| /// |
| /// // Let the other task send values |
| /// time::sleep(Duration::from_millis(20)).await; |
| /// |
| /// tx1.send(4).await.unwrap(); |
| /// }); |
| /// |
| /// tokio::spawn(async move { |
| /// // Wait for the first task to send values |
| /// time::sleep(Duration::from_millis(5)).await; |
| /// |
| /// tx2.send(3).await.unwrap(); |
| /// |
| /// time::sleep(Duration::from_millis(25)).await; |
| /// |
| /// // Send the final value |
| /// tx2.send(5).await.unwrap(); |
| /// }); |
| /// |
| /// assert_eq!(1, rx.next().await.unwrap()); |
| /// assert_eq!(2, rx.next().await.unwrap()); |
| /// assert_eq!(3, rx.next().await.unwrap()); |
| /// assert_eq!(4, rx.next().await.unwrap()); |
| /// assert_eq!(5, rx.next().await.unwrap()); |
| /// |
| /// // The merged stream is consumed |
| /// assert!(rx.next().await.is_none()); |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>merge<U>(<span class="self">self</span>, other: U) -> Merge<<span class="self">Self</span>, U> |
| <span class="kw">where |
| </span>U: Stream<Item = <span class="self">Self</span>::Item>, |
| <span class="self">Self</span>: Sized, |
| { |
| Merge::new(<span class="self">self</span>, other) |
| } |
| |
| <span class="doccomment">/// Filters the values produced by this stream according to the provided |
| /// predicate. |
| /// |
| /// As values of this stream are made available, the provided predicate `f` |
| /// will be run against them. If the predicate |
| /// resolves to `true`, then the stream will yield the value, but if the |
| /// predicate resolves to `false`, then the value |
| /// will be discarded and the next value will be produced. |
| /// |
| /// Note that this function consumes the stream passed into it and returns a |
| /// wrapped version of it, similar to [`Iterator::filter`] method in the |
| /// standard library. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let stream = stream::iter(1..=8); |
| /// let mut evens = stream.filter(|x| x % 2 == 0); |
| /// |
| /// assert_eq!(Some(2), evens.next().await); |
| /// assert_eq!(Some(4), evens.next().await); |
| /// assert_eq!(Some(6), evens.next().await); |
| /// assert_eq!(Some(8), evens.next().await); |
| /// assert_eq!(None, evens.next().await); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>filter<F>(<span class="self">self</span>, f: F) -> Filter<<span class="self">Self</span>, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="kw-2">&</span><span class="self">Self</span>::Item) -> bool, |
| <span class="self">Self</span>: Sized, |
| { |
| Filter::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Filters the values produced by this stream while simultaneously mapping |
| /// them to a different type according to the provided closure. |
| /// |
| /// As values of this stream are made available, the provided function will |
| /// be run on them. If the predicate `f` resolves to |
| /// [`Some(item)`](Some) then the stream will yield the value `item`, but if |
| /// it resolves to [`None`], then the value will be skipped. |
| /// |
| /// Note that this function consumes the stream passed into it and returns a |
| /// wrapped version of it, similar to [`Iterator::filter_map`] method in the |
| /// standard library. |
| /// |
| /// # Examples |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let stream = stream::iter(1..=8); |
| /// let mut evens = stream.filter_map(|x| { |
| /// if x % 2 == 0 { Some(x + 1) } else { None } |
| /// }); |
| /// |
| /// assert_eq!(Some(3), evens.next().await); |
| /// assert_eq!(Some(5), evens.next().await); |
| /// assert_eq!(Some(7), evens.next().await); |
| /// assert_eq!(Some(9), evens.next().await); |
| /// assert_eq!(None, evens.next().await); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>filter_map<T, F>(<span class="self">self</span>, f: F) -> FilterMap<<span class="self">Self</span>, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="self">Self</span>::Item) -> <span class="prelude-ty">Option</span><T>, |
| <span class="self">Self</span>: Sized, |
| { |
| FilterMap::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Creates a stream which ends after the first `None`. |
| /// |
| /// After a stream returns `None`, behavior is undefined. Future calls to |
| /// `poll_next` may or may not return `Some(T)` again or they may panic. |
| /// `fuse()` adapts a stream, ensuring that after `None` is given, it will |
| /// return `None` forever. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio_stream::{Stream, StreamExt}; |
| /// |
| /// use std::pin::Pin; |
| /// use std::task::{Context, Poll}; |
| /// |
| /// // a stream which alternates between Some and None |
| /// struct Alternate { |
| /// state: i32, |
| /// } |
| /// |
| /// impl Stream for Alternate { |
| /// type Item = i32; |
| /// |
| /// fn poll_next(mut self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Option<i32>> { |
| /// let val = self.state; |
| /// self.state = self.state + 1; |
| /// |
| /// // if it's even, Some(i32), else None |
| /// if val % 2 == 0 { |
| /// Poll::Ready(Some(val)) |
| /// } else { |
| /// Poll::Ready(None) |
| /// } |
| /// } |
| /// } |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let mut stream = Alternate { state: 0 }; |
| /// |
| /// // the stream goes back and forth |
| /// assert_eq!(stream.next().await, Some(0)); |
| /// assert_eq!(stream.next().await, None); |
| /// assert_eq!(stream.next().await, Some(2)); |
| /// assert_eq!(stream.next().await, None); |
| /// |
| /// // however, once it is fused |
| /// let mut stream = stream.fuse(); |
| /// |
| /// assert_eq!(stream.next().await, Some(4)); |
| /// assert_eq!(stream.next().await, None); |
| /// |
| /// // it will always return `None` after the first time. |
| /// assert_eq!(stream.next().await, None); |
| /// assert_eq!(stream.next().await, None); |
| /// assert_eq!(stream.next().await, None); |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>fuse(<span class="self">self</span>) -> Fuse<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| Fuse::new(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Creates a new stream of at most `n` items of the underlying stream. |
| /// |
| /// Once `n` items have been yielded from this stream then it will always |
| /// return that the stream is done. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let mut stream = stream::iter(1..=10).take(3); |
| /// |
| /// assert_eq!(Some(1), stream.next().await); |
| /// assert_eq!(Some(2), stream.next().await); |
| /// assert_eq!(Some(3), stream.next().await); |
| /// assert_eq!(None, stream.next().await); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>take(<span class="self">self</span>, n: usize) -> Take<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| Take::new(<span class="self">self</span>, n) |
| } |
| |
| <span class="doccomment">/// Take elements from this stream while the provided predicate |
| /// resolves to `true`. |
| /// |
| /// This function, like `Iterator::take_while`, will take elements from the |
| /// stream until the predicate `f` resolves to `false`. Once one element |
| /// returns false it will always return that the stream is done. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let mut stream = stream::iter(1..=10).take_while(|x| *x <= 3); |
| /// |
| /// assert_eq!(Some(1), stream.next().await); |
| /// assert_eq!(Some(2), stream.next().await); |
| /// assert_eq!(Some(3), stream.next().await); |
| /// assert_eq!(None, stream.next().await); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>take_while<F>(<span class="self">self</span>, f: F) -> TakeWhile<<span class="self">Self</span>, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="kw-2">&</span><span class="self">Self</span>::Item) -> bool, |
| <span class="self">Self</span>: Sized, |
| { |
| TakeWhile::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Creates a new stream that will skip the `n` first items of the |
| /// underlying stream. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let mut stream = stream::iter(1..=10).skip(7); |
| /// |
| /// assert_eq!(Some(8), stream.next().await); |
| /// assert_eq!(Some(9), stream.next().await); |
| /// assert_eq!(Some(10), stream.next().await); |
| /// assert_eq!(None, stream.next().await); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>skip(<span class="self">self</span>, n: usize) -> Skip<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| Skip::new(<span class="self">self</span>, n) |
| } |
| |
| <span class="doccomment">/// Skip elements from the underlying stream while the provided predicate |
| /// resolves to `true`. |
| /// |
| /// This function, like [`Iterator::skip_while`], will ignore elements from the |
| /// stream until the predicate `f` resolves to `false`. Once one element |
| /// returns false, the rest of the elements will be yielded. |
| /// |
| /// [`Iterator::skip_while`]: std::iter::Iterator::skip_while() |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// let mut stream = stream::iter(vec![1,2,3,4,1]).skip_while(|x| *x < 3); |
| /// |
| /// assert_eq!(Some(3), stream.next().await); |
| /// assert_eq!(Some(4), stream.next().await); |
| /// assert_eq!(Some(1), stream.next().await); |
| /// assert_eq!(None, stream.next().await); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>skip_while<F>(<span class="self">self</span>, f: F) -> SkipWhile<<span class="self">Self</span>, F> |
| <span class="kw">where |
| </span>F: FnMut(<span class="kw-2">&</span><span class="self">Self</span>::Item) -> bool, |
| <span class="self">Self</span>: Sized, |
| { |
| SkipWhile::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Tests if every element of the stream matches a predicate. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn all<F>(&mut self, f: F) -> bool; |
| /// ``` |
| /// |
| /// `all()` takes a closure that returns `true` or `false`. It applies |
| /// this closure to each element of the stream, and if they all return |
| /// `true`, then so does `all`. If any of them return `false`, it |
| /// returns `false`. An empty stream returns `true`. |
| /// |
| /// `all()` is short-circuiting; in other words, it will stop processing |
| /// as soon as it finds a `false`, given that no matter what else happens, |
| /// the result will also be `false`. |
| /// |
| /// An empty stream returns `true`. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let a = [1, 2, 3]; |
| /// |
| /// assert!(stream::iter(&a).all(|&x| x > 0).await); |
| /// |
| /// assert!(!stream::iter(&a).all(|&x| x > 2).await); |
| /// # } |
| /// ``` |
| /// |
| /// Stopping at the first `false`: |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let a = [1, 2, 3]; |
| /// |
| /// let mut iter = stream::iter(&a); |
| /// |
| /// assert!(!iter.all(|&x| x != 2).await); |
| /// |
| /// // we can still use `iter`, as there are more elements. |
| /// assert_eq!(iter.next().await, Some(&3)); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>all<F>(<span class="kw-2">&mut </span><span class="self">self</span>, f: F) -> AllFuture<<span class="lifetime">'_</span>, <span class="self">Self</span>, F> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Unpin, |
| F: FnMut(<span class="self">Self</span>::Item) -> bool, |
| { |
| AllFuture::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Tests if any element of the stream matches a predicate. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn any<F>(&mut self, f: F) -> bool; |
| /// ``` |
| /// |
| /// `any()` takes a closure that returns `true` or `false`. It applies |
| /// this closure to each element of the stream, and if any of them return |
| /// `true`, then so does `any()`. If they all return `false`, it |
| /// returns `false`. |
| /// |
| /// `any()` is short-circuiting; in other words, it will stop processing |
| /// as soon as it finds a `true`, given that no matter what else happens, |
| /// the result will also be `true`. |
| /// |
| /// An empty stream returns `false`. |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let a = [1, 2, 3]; |
| /// |
| /// assert!(stream::iter(&a).any(|&x| x > 0).await); |
| /// |
| /// assert!(!stream::iter(&a).any(|&x| x > 5).await); |
| /// # } |
| /// ``` |
| /// |
| /// Stopping at the first `true`: |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// let a = [1, 2, 3]; |
| /// |
| /// let mut iter = stream::iter(&a); |
| /// |
| /// assert!(iter.any(|&x| x != 2).await); |
| /// |
| /// // we can still use `iter`, as there are more elements. |
| /// assert_eq!(iter.next().await, Some(&2)); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>any<F>(<span class="kw-2">&mut </span><span class="self">self</span>, f: F) -> AnyFuture<<span class="lifetime">'_</span>, <span class="self">Self</span>, F> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Unpin, |
| F: FnMut(<span class="self">Self</span>::Item) -> bool, |
| { |
| AnyFuture::new(<span class="self">self</span>, f) |
| } |
| |
| <span class="doccomment">/// Combine two streams into one by first returning all values from the |
| /// first stream then all values from the second stream. |
| /// |
| /// As long as `self` still has values to emit, no values from `other` are |
| /// emitted, even if some are ready. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let one = stream::iter(vec![1, 2, 3]); |
| /// let two = stream::iter(vec![4, 5, 6]); |
| /// |
| /// let mut stream = one.chain(two); |
| /// |
| /// assert_eq!(stream.next().await, Some(1)); |
| /// assert_eq!(stream.next().await, Some(2)); |
| /// assert_eq!(stream.next().await, Some(3)); |
| /// assert_eq!(stream.next().await, Some(4)); |
| /// assert_eq!(stream.next().await, Some(5)); |
| /// assert_eq!(stream.next().await, Some(6)); |
| /// assert_eq!(stream.next().await, None); |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>chain<U>(<span class="self">self</span>, other: U) -> Chain<<span class="self">Self</span>, U> |
| <span class="kw">where |
| </span>U: Stream<Item = <span class="self">Self</span>::Item>, |
| <span class="self">Self</span>: Sized, |
| { |
| Chain::new(<span class="self">self</span>, other) |
| } |
| |
| <span class="doccomment">/// A combinator that applies a function to every element in a stream |
| /// producing a single, final value. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn fold<B, F>(self, init: B, f: F) -> B; |
| /// ``` |
| /// |
| /// # Examples |
| /// Basic usage: |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, *}; |
| /// |
| /// let s = stream::iter(vec![1u8, 2, 3]); |
| /// let sum = s.fold(0, |acc, x| acc + x).await; |
| /// |
| /// assert_eq!(sum, 6); |
| /// # } |
| /// ``` |
| </span><span class="kw">fn </span>fold<B, F>(<span class="self">self</span>, init: B, f: F) -> FoldFuture<<span class="self">Self</span>, B, F> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| F: FnMut(B, <span class="self">Self</span>::Item) -> B, |
| { |
| FoldFuture::new(<span class="self">self</span>, init, f) |
| } |
| |
| <span class="doccomment">/// Drain stream pushing all emitted values into a collection. |
| /// |
| /// Equivalent to: |
| /// |
| /// ```ignore |
| /// async fn collect<T>(self) -> T; |
| /// ``` |
| /// |
| /// `collect` streams all values, awaiting as needed. Values are pushed into |
| /// a collection. A number of different target collection types are |
| /// supported, including [`Vec`](std::vec::Vec), |
| /// [`String`](std::string::String), and [`Bytes`]. |
| /// |
| /// [`Bytes`]: https://docs.rs/bytes/0.6.0/bytes/struct.Bytes.html |
| /// |
| /// # `Result` |
| /// |
| /// `collect()` can also be used with streams of type `Result<T, E>` where |
| /// `T: FromStream<_>`. In this case, `collect()` will stream as long as |
| /// values yielded from the stream are `Ok(_)`. If `Err(_)` is encountered, |
| /// streaming is terminated and `collect()` returns the `Err`. |
| /// |
| /// # Notes |
| /// |
| /// `FromStream` is currently a sealed trait. Stabilization is pending |
| /// enhancements to the Rust language. |
| /// |
| /// # Examples |
| /// |
| /// Basic usage: |
| /// |
| /// ``` |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let doubled: Vec<i32> = |
| /// stream::iter(vec![1, 2, 3]) |
| /// .map(|x| x * 2) |
| /// .collect() |
| /// .await; |
| /// |
| /// assert_eq!(vec![2, 4, 6], doubled); |
| /// } |
| /// ``` |
| /// |
| /// Collecting a stream of `Result` values |
| /// |
| /// ``` |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// // A stream containing only `Ok` values will be collected |
| /// let values: Result<Vec<i32>, &str> = |
| /// stream::iter(vec![Ok(1), Ok(2), Ok(3)]) |
| /// .collect() |
| /// .await; |
| /// |
| /// assert_eq!(Ok(vec![1, 2, 3]), values); |
| /// |
| /// // A stream containing `Err` values will return the first error. |
| /// let results = vec![Ok(1), Err("no"), Ok(2), Ok(3), Err("nein")]; |
| /// |
| /// let values: Result<Vec<i32>, &str> = |
| /// stream::iter(results) |
| /// .collect() |
| /// .await; |
| /// |
| /// assert_eq!(Err("no"), values); |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>collect<T>(<span class="self">self</span>) -> Collect<<span class="self">Self</span>, T> |
| <span class="kw">where |
| </span>T: FromStream<<span class="self">Self</span>::Item>, |
| <span class="self">Self</span>: Sized, |
| { |
| Collect::new(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Applies a per-item timeout to the passed stream. |
| /// |
| /// `timeout()` takes a `Duration` that represents the maximum amount of |
| /// time each element of the stream has to complete before timing out. |
| /// |
| /// If the wrapped stream yields a value before the deadline is reached, the |
| /// value is returned. Otherwise, an error is returned. The caller may decide |
| /// to continue consuming the stream and will eventually get the next source |
| /// stream value once it becomes available. See |
| /// [`timeout_repeating`](StreamExt::timeout_repeating) for an alternative |
| /// where the timeouts will repeat. |
| /// |
| /// # Notes |
| /// |
| /// This function consumes the stream passed into it and returns a |
| /// wrapped version of it. |
| /// |
| /// Polling the returned stream will continue to poll the inner stream even |
| /// if one or more items time out. |
| /// |
| /// # Examples |
| /// |
| /// Suppose we have a stream `int_stream` that yields 3 numbers (1, 2, 3): |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// use std::time::Duration; |
| /// # let int_stream = stream::iter(1..=3); |
| /// |
| /// let int_stream = int_stream.timeout(Duration::from_secs(1)); |
| /// tokio::pin!(int_stream); |
| /// |
| /// // When no items time out, we get the 3 elements in succession: |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(1))); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(2))); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(3))); |
| /// assert_eq!(int_stream.try_next().await, Ok(None)); |
| /// |
| /// // If the second item times out, we get an error and continue polling the stream: |
| /// # let mut int_stream = stream::iter(vec![Ok(1), Err(()), Ok(2), Ok(3)]); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(1))); |
| /// assert!(int_stream.try_next().await.is_err()); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(2))); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(3))); |
| /// assert_eq!(int_stream.try_next().await, Ok(None)); |
| /// |
| /// // If we want to stop consuming the source stream the first time an |
| /// // element times out, we can use the `take_while` operator: |
| /// # let int_stream = stream::iter(vec![Ok(1), Err(()), Ok(2), Ok(3)]); |
| /// let mut int_stream = int_stream.take_while(Result::is_ok); |
| /// |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(1))); |
| /// assert_eq!(int_stream.try_next().await, Ok(None)); |
| /// # } |
| /// ``` |
| /// |
| /// Once a timeout error is received, no further events will be received |
| /// unless the wrapped stream yields a value (timeouts do not repeat). |
| /// |
| /// ``` |
| /// # #[tokio::main(flavor = "current_thread", start_paused = true)] |
| /// # async fn main() { |
| /// use tokio_stream::{StreamExt, wrappers::IntervalStream}; |
| /// use std::time::Duration; |
| /// let interval_stream = IntervalStream::new(tokio::time::interval(Duration::from_millis(100))); |
| /// let timeout_stream = interval_stream.timeout(Duration::from_millis(10)); |
| /// tokio::pin!(timeout_stream); |
| /// |
| /// // Only one timeout will be received between values in the source stream. |
| /// assert!(timeout_stream.try_next().await.is_ok()); |
| /// assert!(timeout_stream.try_next().await.is_err(), "expected one timeout"); |
| /// assert!(timeout_stream.try_next().await.is_ok(), "expected no more timeouts"); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[cfg(all(feature = <span class="string">"time"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"time"</span>)))] |
| </span><span class="kw">fn </span>timeout(<span class="self">self</span>, duration: Duration) -> Timeout<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| Timeout::new(<span class="self">self</span>, duration) |
| } |
| |
| <span class="doccomment">/// Applies a per-item timeout to the passed stream. |
| /// |
| /// `timeout_repeating()` takes an [`Interval`](tokio::time::Interval) that |
| /// controls the time each element of the stream has to complete before |
| /// timing out. |
| /// |
| /// If the wrapped stream yields a value before the deadline is reached, the |
| /// value is returned. Otherwise, an error is returned. The caller may decide |
| /// to continue consuming the stream and will eventually get the next source |
| /// stream value once it becomes available. Unlike `timeout()`, if no value |
| /// becomes available before the deadline is reached, additional errors are |
| /// returned at the specified interval. See [`timeout`](StreamExt::timeout) |
| /// for an alternative where the timeouts do not repeat. |
| /// |
| /// # Notes |
| /// |
| /// This function consumes the stream passed into it and returns a |
| /// wrapped version of it. |
| /// |
| /// Polling the returned stream will continue to poll the inner stream even |
| /// if one or more items time out. |
| /// |
| /// # Examples |
| /// |
| /// Suppose we have a stream `int_stream` that yields 3 numbers (1, 2, 3): |
| /// |
| /// ``` |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// use std::time::Duration; |
| /// # let int_stream = stream::iter(1..=3); |
| /// |
| /// let int_stream = int_stream.timeout_repeating(tokio::time::interval(Duration::from_secs(1))); |
| /// tokio::pin!(int_stream); |
| /// |
| /// // When no items time out, we get the 3 elements in succession: |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(1))); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(2))); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(3))); |
| /// assert_eq!(int_stream.try_next().await, Ok(None)); |
| /// |
| /// // If the second item times out, we get an error and continue polling the stream: |
| /// # let mut int_stream = stream::iter(vec![Ok(1), Err(()), Ok(2), Ok(3)]); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(1))); |
| /// assert!(int_stream.try_next().await.is_err()); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(2))); |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(3))); |
| /// assert_eq!(int_stream.try_next().await, Ok(None)); |
| /// |
| /// // If we want to stop consuming the source stream the first time an |
| /// // element times out, we can use the `take_while` operator: |
| /// # let int_stream = stream::iter(vec![Ok(1), Err(()), Ok(2), Ok(3)]); |
| /// let mut int_stream = int_stream.take_while(Result::is_ok); |
| /// |
| /// assert_eq!(int_stream.try_next().await, Ok(Some(1))); |
| /// assert_eq!(int_stream.try_next().await, Ok(None)); |
| /// # } |
| /// ``` |
| /// |
| /// Timeout errors will be continuously produced at the specified interval |
| /// until the wrapped stream yields a value. |
| /// |
| /// ``` |
| /// # #[tokio::main(flavor = "current_thread", start_paused = true)] |
| /// # async fn main() { |
| /// use tokio_stream::{StreamExt, wrappers::IntervalStream}; |
| /// use std::time::Duration; |
| /// let interval_stream = IntervalStream::new(tokio::time::interval(Duration::from_millis(23))); |
| /// let timeout_stream = interval_stream.timeout_repeating(tokio::time::interval(Duration::from_millis(9))); |
| /// tokio::pin!(timeout_stream); |
| /// |
| /// // Multiple timeouts will be received between values in the source stream. |
| /// assert!(timeout_stream.try_next().await.is_ok()); |
| /// assert!(timeout_stream.try_next().await.is_err(), "expected one timeout"); |
| /// assert!(timeout_stream.try_next().await.is_err(), "expected a second timeout"); |
| /// // Will eventually receive another value from the source stream... |
| /// assert!(timeout_stream.try_next().await.is_ok(), "expected non-timeout"); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[cfg(all(feature = <span class="string">"time"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"time"</span>)))] |
| </span><span class="kw">fn </span>timeout_repeating(<span class="self">self</span>, interval: Interval) -> TimeoutRepeating<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| TimeoutRepeating::new(<span class="self">self</span>, interval) |
| } |
| |
| <span class="doccomment">/// Slows down a stream by enforcing a delay between items. |
| /// |
| /// The underlying timer behind this utility has a granularity of one millisecond. |
| /// |
| /// # Example |
| /// |
| /// Create a throttled stream. |
| /// ```rust,no_run |
| /// use std::time::Duration; |
| /// use tokio_stream::StreamExt; |
| /// |
| /// # async fn dox() { |
| /// let item_stream = futures::stream::repeat("one").throttle(Duration::from_secs(2)); |
| /// tokio::pin!(item_stream); |
| /// |
| /// loop { |
| /// // The string will be produced at most every 2 seconds |
| /// println!("{:?}", item_stream.next().await); |
| /// } |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[cfg(all(feature = <span class="string">"time"</span>))] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"time"</span>)))] |
| </span><span class="kw">fn </span>throttle(<span class="self">self</span>, duration: Duration) -> Throttle<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| throttle(duration, <span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Batches the items in the given stream using a maximum duration and size for each batch. |
| /// |
| /// This stream returns the next batch of items in the following situations: |
| /// 1. The inner stream has returned at least `max_size` many items since the last batch. |
| /// 2. The time since the first item of a batch is greater than the given duration. |
| /// 3. The end of the stream is reached. |
| /// |
| /// The length of the returned vector is never empty or greater than the maximum size. Empty batches |
| /// will not be emitted if no items are received upstream. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if `max_size` is zero |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use std::time::Duration; |
| /// use tokio::time; |
| /// use tokio_stream::{self as stream, StreamExt}; |
| /// use futures::FutureExt; |
| /// |
| /// #[tokio::main] |
| /// # async fn _unused() {} |
| /// # #[tokio::main(flavor = "current_thread", start_paused = true)] |
| /// async fn main() { |
| /// let iter = vec![1, 2, 3, 4].into_iter(); |
| /// let stream0 = stream::iter(iter); |
| /// |
| /// let iter = vec![5].into_iter(); |
| /// let stream1 = stream::iter(iter) |
| /// .then(move |n| time::sleep(Duration::from_secs(5)).map(move |_| n)); |
| /// |
| /// let chunk_stream = stream0 |
| /// .chain(stream1) |
| /// .chunks_timeout(3, Duration::from_secs(2)); |
| /// tokio::pin!(chunk_stream); |
| /// |
| /// // a full batch was received |
| /// assert_eq!(chunk_stream.next().await, Some(vec![1,2,3])); |
| /// // deadline was reached before max_size was reached |
| /// assert_eq!(chunk_stream.next().await, Some(vec![4])); |
| /// // last element in the stream |
| /// assert_eq!(chunk_stream.next().await, Some(vec![5])); |
| /// } |
| /// ``` |
| </span><span class="attribute">#[cfg(feature = <span class="string">"time"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"time"</span>)))] |
| #[track_caller] |
| </span><span class="kw">fn </span>chunks_timeout(<span class="self">self</span>, max_size: usize, duration: Duration) -> ChunksTimeout<<span class="self">Self</span>> |
| <span class="kw">where |
| </span><span class="self">Self</span>: Sized, |
| { |
| <span class="macro">assert!</span>(max_size > <span class="number">0</span>, <span class="string">"`max_size` must be non-zero."</span>); |
| ChunksTimeout::new(<span class="self">self</span>, max_size, duration) |
| } |
| } |
| |
| <span class="kw">impl</span><St: <span class="question-mark">?</span>Sized> StreamExt <span class="kw">for </span>St <span class="kw">where </span>St: Stream {} |
| |
| <span class="doccomment">/// Merge the size hints from two streams. |
| </span><span class="kw">fn </span>merge_size_hints( |
| (left_low, left_high): (usize, <span class="prelude-ty">Option</span><usize>), |
| (right_low, right_high): (usize, <span class="prelude-ty">Option</span><usize>), |
| ) -> (usize, <span class="prelude-ty">Option</span><usize>) { |
| <span class="kw">let </span>low = left_low.saturating_add(right_low); |
| <span class="kw">let </span>high = <span class="kw">match </span>(left_high, right_high) { |
| (<span class="prelude-val">Some</span>(h1), <span class="prelude-val">Some</span>(h2)) => h1.checked_add(h2), |
| <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| }; |
| (low, high) |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio_stream" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |