<!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 to the Rust file `C:\Users\Chrilieb\.cargo\registry\src\github.com-1ecc6299db9ec823\futures-0.1.14\src\stream\mod.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>mod.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="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>
</pre><pre class="rust ">
<span class="doccomment">//! Asynchronous streams</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This module contains the `Stream` trait and a number of adaptors for this</span>
<span class="doccomment">//! trait. This trait is very similar to the `Iterator` trait in the standard</span>
<span class="doccomment">//! library except that it expresses the concept of blocking as well. A stream</span>
<span class="doccomment">//! here is a sequential sequence of values which may take some amount of time</span>
<span class="doccomment">//! in between to produce.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! A stream may request that it is blocked between values while the next value</span>
<span class="doccomment">//! is calculated, and provides a way to get notified once the next value is</span>
<span class="doccomment">//! ready as well.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! You can find more information/tutorials about streams [online at</span>
<span class="doccomment">//! https://tokio.rs][online]</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [online]: https://tokio.rs/docs/getting-started/streams-and-sinks/</span>
<span class="kw">use</span> {<span class="ident">IntoFuture</span>, <span class="ident">Poll</span>};
<span class="kw">mod</span> <span class="ident">iter</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">iter</span>::{<span class="ident">iter</span>, <span class="ident">Iter</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"with-deprecated"</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">Iter</span> <span class="kw">as</span> <span class="ident">IterStream</span>;
<span class="kw">mod</span> <span class="ident">repeat</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">repeat</span>::{<span class="ident">repeat</span>, <span class="ident">Repeat</span>};
<span class="kw">mod</span> <span class="ident">and_then</span>;
<span class="kw">mod</span> <span class="ident">chain</span>;
<span class="kw">mod</span> <span class="ident">concat</span>;
<span class="kw">mod</span> <span class="ident">empty</span>;
<span class="kw">mod</span> <span class="ident">filter</span>;
<span class="kw">mod</span> <span class="ident">filter_map</span>;
<span class="kw">mod</span> <span class="ident">flatten</span>;
<span class="kw">mod</span> <span class="ident">fold</span>;
<span class="kw">mod</span> <span class="ident">for_each</span>;
<span class="kw">mod</span> <span class="ident">from_err</span>;
<span class="kw">mod</span> <span class="ident">fuse</span>;
<span class="kw">mod</span> <span class="ident">future</span>;
<span class="kw">mod</span> <span class="ident">map</span>;
<span class="kw">mod</span> <span class="ident">map_err</span>;
<span class="kw">mod</span> <span class="ident">merge</span>;
<span class="kw">mod</span> <span class="ident">once</span>;
<span class="kw">mod</span> <span class="ident">or_else</span>;
<span class="kw">mod</span> <span class="ident">peek</span>;
<span class="kw">mod</span> <span class="ident">select</span>;
<span class="kw">mod</span> <span class="ident">skip</span>;
<span class="kw">mod</span> <span class="ident">skip_while</span>;
<span class="kw">mod</span> <span class="ident">take</span>;
<span class="kw">mod</span> <span class="ident">take_while</span>;
<span class="kw">mod</span> <span class="ident">then</span>;
<span class="kw">mod</span> <span class="ident">unfold</span>;
<span class="kw">mod</span> <span class="ident">zip</span>;
<span class="kw">mod</span> <span class="ident">forward</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">and_then</span>::<span class="ident">AndThen</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">chain</span>::<span class="ident">Chain</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">concat</span>::{<span class="ident">Concat</span>, <span class="ident">Concat2</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">empty</span>::{<span class="ident">Empty</span>, <span class="ident">empty</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">filter</span>::<span class="ident">Filter</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">filter_map</span>::<span class="ident">FilterMap</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">flatten</span>::<span class="ident">Flatten</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">fold</span>::<span class="ident">Fold</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">for_each</span>::<span class="ident">ForEach</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">from_err</span>::<span class="ident">FromErr</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">fuse</span>::<span class="ident">Fuse</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">future</span>::<span class="ident">StreamFuture</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">map</span>::<span class="ident">Map</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">map_err</span>::<span class="ident">MapErr</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">merge</span>::{<span class="ident">Merge</span>, <span class="ident">MergedItem</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">once</span>::{<span class="ident">Once</span>, <span class="ident">once</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">or_else</span>::<span class="ident">OrElse</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">peek</span>::<span class="ident">Peekable</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">select</span>::<span class="ident">Select</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">skip</span>::<span class="ident">Skip</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">skip_while</span>::<span class="ident">SkipWhile</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">take</span>::<span class="ident">Take</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">take_while</span>::<span class="ident">TakeWhile</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">then</span>::<span class="ident">Then</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">unfold</span>::{<span class="ident">Unfold</span>, <span class="ident">unfold</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">zip</span>::<span class="ident">Zip</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">forward</span>::<span class="ident">Forward</span>;
<span class="kw">use</span> <span class="ident">sink</span>::{<span class="ident">Sink</span>};
<span class="macro">if_std</span><span class="macro">!</span> {
<span class="kw">use</span> <span class="ident">std</span>;
<span class="kw">mod</span> <span class="ident">buffered</span>;
<span class="kw">mod</span> <span class="ident">buffer_unordered</span>;
<span class="kw">mod</span> <span class="ident">catch_unwind</span>;
<span class="kw">mod</span> <span class="ident">chunks</span>;
<span class="kw">mod</span> <span class="ident">collect</span>;
<span class="kw">mod</span> <span class="ident">wait</span>;
<span class="kw">mod</span> <span class="ident">channel</span>;
<span class="kw">mod</span> <span class="ident">split</span>;
<span class="kw">mod</span> <span class="ident">futures_unordered</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">buffered</span>::<span class="ident">Buffered</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">buffer_unordered</span>::<span class="ident">BufferUnordered</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">catch_unwind</span>::<span class="ident">CatchUnwind</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">chunks</span>::<span class="ident">Chunks</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">collect</span>::<span class="ident">Collect</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">wait</span>::<span class="ident">Wait</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">split</span>::{<span class="ident">SplitStream</span>, <span class="ident">SplitSink</span>};
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">futures_unordered</span>::{<span class="ident">futures_unordered</span>, <span class="ident">FuturesUnordered</span>};
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"with-deprecated"</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">deprecated</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">channel</span>::{<span class="ident">channel</span>, <span class="ident">Sender</span>, <span class="ident">Receiver</span>, <span class="ident">FutureSender</span>, <span class="ident">SendError</span>};
<span class="doccomment">/// A type alias for `Box<Stream + Send>`</span>
<span class="kw">pub</span> <span class="kw">type</span> <span class="ident">BoxStream</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span> <span class="op">=</span> ::<span class="ident">std</span>::<span class="ident">boxed</span>::<span class="ident">Box</span><span class="op"><</span><span class="ident">Stream</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="ident">T</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">E</span><span class="op">></span> <span class="op">+</span> <span class="ident">Send</span><span class="op">></span>;
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="question-mark">?</span><span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Stream</span><span class="op">></span> <span class="ident">Stream</span> <span class="kw">for</span> ::<span class="ident">std</span>::<span class="ident">boxed</span>::<span class="ident">Box</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">S</span>::<span class="ident">Item</span>;
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">S</span>::<span class="ident">Error</span>;
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span><span class="op">></span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
(<span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">poll</span>()
}
}
}
<span class="doccomment">/// A stream of values, not all of which may have been produced yet.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `Stream` is a trait to represent any source of sequential events or items</span>
<span class="doccomment">/// which acts like an iterator but long periods of time may pass between</span>
<span class="doccomment">/// items. Like `Future` the methods of `Stream` never block and it is thus</span>
<span class="doccomment">/// suitable for programming in an asynchronous fashion. This trait is very</span>
<span class="doccomment">/// similar to the `Iterator` trait in the standard library where `Some` is</span>
<span class="doccomment">/// used to signal elements of the stream and `None` is used to indicate that</span>
<span class="doccomment">/// the stream is finished.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Like futures a stream has basic combinators to transform the stream, perform</span>
<span class="doccomment">/// more work on each item, etc.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// You can find more information/tutorials about streams [online at</span>
<span class="doccomment">/// https://tokio.rs][online]</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [online]: https://tokio.rs/docs/getting-started/streams-and-sinks/</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Streams as Futures</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Any instance of `Stream` can also be viewed as a `Future` where the resolved</span>
<span class="doccomment">/// value is the next item in the stream along with the rest of the stream. The</span>
<span class="doccomment">/// `into_future` adaptor can be used here to convert any stream into a future</span>
<span class="doccomment">/// for use with other future methods like `join` and `select`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Streams, like futures, can also model errors in their computation. All</span>
<span class="doccomment">/// streams have an associated `Error` type like with futures. Currently as of</span>
<span class="doccomment">/// the 0.1 release of this library an error on a stream **does not terminate</span>
<span class="doccomment">/// the stream**. That is, after one error is received, another error may be</span>
<span class="doccomment">/// received from the same stream (it's valid to keep polling).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This property of streams, however, is [being considered] for change in 0.2</span>
<span class="doccomment">/// where an error on a stream is similar to `None`, it terminates the stream</span>
<span class="doccomment">/// entirely. If one of these use cases suits you perfectly and not the other,</span>
<span class="doccomment">/// please feel welcome to comment on [the issue][being considered]!</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [being considered]: https://github.com/alexcrichton/futures-rs/issues/206</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Stream</span> {
<span class="doccomment">/// The type of item this stream will yield on success.</span>
<span class="kw">type</span> <span class="ident">Item</span>;
<span class="doccomment">/// The type of error this stream may generate.</span>
<span class="kw">type</span> <span class="ident">Error</span>;
<span class="doccomment">/// Attempt to pull out the next value of this stream, returning `None` if</span>
<span class="doccomment">/// the stream is finished.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method, like `Future::poll`, is the sole method of pulling out a</span>
<span class="doccomment">/// value from a stream. This method must also be run within the context of</span>
<span class="doccomment">/// a task typically and implementors of this trait must ensure that</span>
<span class="doccomment">/// implementations of this method do not block, as it may cause consumers</span>
<span class="doccomment">/// to behave badly.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Return value</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If `NotReady` is returned then this stream's next value is not ready</span>
<span class="doccomment">/// yet and implementations will ensure that the current task will be</span>
<span class="doccomment">/// notified when the next value may be ready. If `Some` is returned then</span>
<span class="doccomment">/// the returned value represents the next value on the stream. `Err`</span>
<span class="doccomment">/// indicates an error happened, while `Ok` indicates whether there was a</span>
<span class="doccomment">/// new item on the stream or whether the stream has terminated.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Once a stream is finished, that is `Ready(None)` has been returned,</span>
<span class="doccomment">/// further calls to `poll` may result in a panic or other "bad behavior".</span>
<span class="doccomment">/// If this is difficult to guard against then the `fuse` adapter can be</span>
<span class="doccomment">/// used to ensure that `poll` always has well-defined semantics.</span>
<span class="comment">// TODO: more here</span>
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span><span class="op">></span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>;
<span class="comment">// TODO: should there also be a method like `poll` but doesn't return an</span>
<span class="comment">// item? basically just says "please make more progress internally"</span>
<span class="comment">// seems crucial for buffering to actually make any sense.</span>
<span class="doccomment">/// Creates an iterator which blocks the current thread until each item of</span>
<span class="doccomment">/// this stream is resolved.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will consume ownership of this stream, returning an</span>
<span class="doccomment">/// implementation of a standard iterator. This iterator will *block the</span>
<span class="doccomment">/// current thread* on each call to `next` if the item in the stream isn't</span>
<span class="doccomment">/// ready yet.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note:** This method is not appropriate to call on event loops or</span>
<span class="doccomment">/// > similar I/O situations because it will prevent the event</span>
<span class="doccomment">/// > loop from making progress (this blocks the thread). This</span>
<span class="doccomment">/// > method should only be called when it's guaranteed that the</span>
<span class="doccomment">/// > blocking work associated with this stream will be completed</span>
<span class="doccomment">/// > by another thread.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned iterator does not attempt to catch panics. If the `poll`</span>
<span class="doccomment">/// function panics, panics will be propagated to the caller of `next`.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">wait</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Wait</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">wait</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Convenience function for turning this stream into a trait object.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This simply avoids the need to write `Box::new` and can often help with</span>
<span class="doccomment">/// type inference as well by always returning a trait object. Note that</span>
<span class="doccomment">/// this method requires the `Send` bound and returns a `BoxStream`, which</span>
<span class="doccomment">/// also encodes this. If you'd like to create a `Box<Stream>` without the</span>
<span class="doccomment">/// `Send` bound, then the `Box::new` function can be used instead.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::stream::*;</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (_tx, rx) = mpsc::channel(1);</span>
<span class="doccomment">/// let a: BoxStream<i32, ()> = rx.boxed();</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">boxed</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">BoxStream</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="lifetime">'static</span>,
{
::<span class="ident">std</span>::<span class="ident">boxed</span>::<span class="ident">Box</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Converts this stream into a `Future`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A stream can be viewed as a future which will resolve to a pair containing</span>
<span class="doccomment">/// the next element of the stream plus the remaining stream. If the stream</span>
<span class="doccomment">/// terminates, then the next element is `None` and the remaining stream is</span>
<span class="doccomment">/// still passed back, to allow reclamation of its resources.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned future can be used to compose streams and futures together by</span>
<span class="doccomment">/// placing everything into the "world of futures".</span>
<span class="kw">fn</span> <span class="ident">into_future</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">StreamFuture</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">future</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Converts a stream of type `T` to a stream of type `U`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The provided closure is executed over all elements of this stream as</span>
<span class="doccomment">/// they are made available, and the callback will be executed inline with</span>
<span class="doccomment">/// calls to `poll`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it, similar to the existing `map` methods in the</span>
<span class="doccomment">/// standard library.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::Stream;</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (_tx, rx) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">/// let rx = rx.map(|x| x + 3);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">map</span><span class="op"><</span><span class="ident">U</span>, <span class="ident">F</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">Map</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="ident">U</span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">map</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Converts a stream of error type `T` to a stream of error type `U`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The provided closure is executed over all errors of this stream as</span>
<span class="doccomment">/// they are made available, and the callback will be executed inline with</span>
<span class="doccomment">/// calls to `poll`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it, similar to the existing `map_err` methods in the</span>
<span class="doccomment">/// standard library.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::Stream;</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (_tx, rx) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">/// let rx = rx.map_err(|()| 3);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">map_err</span><span class="op"><</span><span class="ident">U</span>, <span class="ident">F</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">MapErr</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="self">Self</span>::<span class="ident">Error</span>) <span class="op">-></span> <span class="ident">U</span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">map_err</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Filters the values produced by this stream according to the provided</span>
<span class="doccomment">/// predicate.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// As values of this stream are made available, the provided predicate will</span>
<span class="doccomment">/// be run against them. If the predicate returns `true` then the stream</span>
<span class="doccomment">/// will yield the value, but if the predicate returns `false` then the</span>
<span class="doccomment">/// value will be discarded and the next value will be produced.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// All errors are passed through without filtering in this combinator.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it, similar to the existing `filter` methods in the</span>
<span class="doccomment">/// standard library.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::Stream;</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (_tx, rx) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">/// let evens = rx.filter(|x| x % 0 == 2);</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">filter</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">Filter</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="kw-2">&</span><span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="ident">bool</span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">filter</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Filters the values produced by this stream while simultaneously mapping</span>
<span class="doccomment">/// them to a different type.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// As values of this stream are made available, the provided function will</span>
<span class="doccomment">/// be run on them. If the predicate returns `Some(e)` then the stream will</span>
<span class="doccomment">/// yield the value `e`, but if the predicate returns `None` then the next</span>
<span class="doccomment">/// value will be produced.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// All errors are passed through without filtering in this combinator.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it, similar to the existing `filter_map` methods in the</span>
<span class="doccomment">/// standard library.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::Stream;</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (_tx, rx) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">/// let evens_plus_one = rx.filter_map(|x| {</span>
<span class="doccomment">/// if x % 0 == 2 {</span>
<span class="doccomment">/// Some(x + 1)</span>
<span class="doccomment">/// } else {</span>
<span class="doccomment">/// None</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">filter_map</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">B</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">FilterMap</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">B</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">filter_map</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Chain on a computation for when a value is ready, passing the resulting</span>
<span class="doccomment">/// item to the provided closure `f`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function can be used to ensure a computation runs regardless of</span>
<span class="doccomment">/// the next value on the stream. The closure provided will be yielded a</span>
<span class="doccomment">/// `Result` once a value is ready, and the returned future will then be run</span>
<span class="doccomment">/// to completion to produce the next value on this stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned value of the closure must implement the `IntoFuture` trait</span>
<span class="doccomment">/// and can represent some more work to be done before the composed stream</span>
<span class="doccomment">/// is finished. Note that the `Result` type implements the `IntoFuture`</span>
<span class="doccomment">/// trait so it is possible to simply alter the `Result` yielded to the</span>
<span class="doccomment">/// closure and return it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::Stream;</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (_tx, rx) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let rx = rx.then(|result| {</span>
<span class="doccomment">/// match result {</span>
<span class="doccomment">/// Ok(e) => Ok(e + 3),</span>
<span class="doccomment">/// Err(()) => Err(4),</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">then</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">Then</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>) <span class="op">-></span> <span class="ident">U</span>,
<span class="ident">U</span>: <span class="ident">IntoFuture</span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">then</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Chain on a computation for when a value is ready, passing the successful</span>
<span class="doccomment">/// results to the provided closure `f`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function can be used to run a unit of work when the next successful</span>
<span class="doccomment">/// value on a stream is ready. The closure provided will be yielded a value</span>
<span class="doccomment">/// when ready, and the returned future will then be run to completion to</span>
<span class="doccomment">/// produce the next value on this stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Any errors produced by this stream will not be passed to the closure,</span>
<span class="doccomment">/// and will be passed through.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned value of the closure must implement the `IntoFuture` trait</span>
<span class="doccomment">/// and can represent some more work to be done before the composed stream</span>
<span class="doccomment">/// is finished. Note that the `Result` type implements the `IntoFuture`</span>
<span class="doccomment">/// trait so it is possible to simply alter the `Result` yielded to the</span>
<span class="doccomment">/// closure and return it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::stream::*;</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (_tx, rx) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let rx = rx.and_then(|result| {</span>
<span class="doccomment">/// if result % 2 == 0 {</span>
<span class="doccomment">/// Ok(result)</span>
<span class="doccomment">/// } else {</span>
<span class="doccomment">/// Err(())</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">and_then</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">AndThen</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="ident">U</span>,
<span class="ident">U</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Error</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">and_then</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Chain on a computation for when an error happens, passing the</span>
<span class="doccomment">/// erroneous result to the provided closure `f`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function can be used to run a unit of work and attempt to recover from</span>
<span class="doccomment">/// an error if one happens. The closure provided will be yielded an error</span>
<span class="doccomment">/// when one appears, and the returned future will then be run to completion</span>
<span class="doccomment">/// to produce the next value on this stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Any successful values produced by this stream will not be passed to the</span>
<span class="doccomment">/// closure, and will be passed through.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned value of the closure must implement the `IntoFuture` trait</span>
<span class="doccomment">/// and can represent some more work to be done before the composed stream</span>
<span class="doccomment">/// is finished. Note that the `Result` type implements the `IntoFuture`</span>
<span class="doccomment">/// trait so it is possible to simply alter the `Result` yielded to the</span>
<span class="doccomment">/// closure and return it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it.</span>
<span class="kw">fn</span> <span class="ident">or_else</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">OrElse</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="self">Self</span>::<span class="ident">Error</span>) <span class="op">-></span> <span class="ident">U</span>,
<span class="ident">U</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Item</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">or_else</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Collect all of the values of this stream into a vector, returning a</span>
<span class="doccomment">/// future representing the result of that computation.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This combinator will collect all successful results of this stream and</span>
<span class="doccomment">/// collect them into a `Vec<Self::Item>`. If an error happens then all</span>
<span class="doccomment">/// collected elements will be dropped and the error will be returned.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned future will be resolved whenever an error happens or when</span>
<span class="doccomment">/// the stream returns `Ok(None)`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::thread;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// use futures::{Stream, Future, Sink};</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (mut tx, rx) = mpsc::channel(1);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// thread::spawn(|| {</span>
<span class="doccomment">/// for i in (0..5).rev() {</span>
<span class="doccomment">/// tx = tx.send(i + 1).wait().unwrap();</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// });</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let mut result = rx.collect();</span>
<span class="doccomment">/// assert_eq!(result.wait(), Ok(vec![5, 4, 3, 2, 1]));</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">collect</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Collect</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">collect</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Concatenate all results of a stream into a single extendable</span>
<span class="doccomment">/// destination, returning a future representing the end result.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This combinator will extend the first item with the contents</span>
<span class="doccomment">/// of all the successful results of the stream. If the stream is</span>
<span class="doccomment">/// empty, the default value will be returned. If an error occurs,</span>
<span class="doccomment">/// all the results will be dropped and the error will be returned.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The name `concat2` is an intermediate measure until the release of</span>
<span class="doccomment">/// futures 0.2, at which point it will be renamed back to `concat`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::thread;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// use futures::{Future, Sink, Stream};</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (mut tx, rx) = mpsc::channel(1);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// thread::spawn(move || {</span>
<span class="doccomment">/// for i in (0..3).rev() {</span>
<span class="doccomment">/// let n = i * 3;</span>
<span class="doccomment">/// tx = tx.send(vec![n + 1, n + 2, n + 3]).wait().unwrap();</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// let result = rx.concat2();</span>
<span class="doccomment">/// assert_eq!(result.wait(), Ok(vec![7, 8, 9, 4, 5, 6, 1, 2, 3]));</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">concat2</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Concat2</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>,
<span class="self">Self</span>::<span class="ident">Item</span>: <span class="ident">Extend</span><span class="op"><<</span><span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Stream</span><span class="op">></span>::<span class="ident">Item</span> <span class="kw">as</span> <span class="ident">IntoIterator</span><span class="op">></span>::<span class="ident">Item</span><span class="op">></span> <span class="op">+</span> <span class="ident">IntoIterator</span> <span class="op">+</span> <span class="ident">Default</span>,
{
<span class="ident">concat</span>::<span class="ident">new2</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Concatenate all results of a stream into a single extendable</span>
<span class="doccomment">/// destination, returning a future representing the end result.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This combinator will extend the first item with the contents</span>
<span class="doccomment">/// of all the successful results of the stream. If an error occurs,</span>
<span class="doccomment">/// all the results will be dropped and the error will be returned.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::thread;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// use futures::{Future, Sink, Stream};</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (mut tx, rx) = mpsc::channel(1);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// thread::spawn(move || {</span>
<span class="doccomment">/// for i in (0..3).rev() {</span>
<span class="doccomment">/// let n = i * 3;</span>
<span class="doccomment">/// tx = tx.send(vec![n + 1, n + 2, n + 3]).wait().unwrap();</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// let result = rx.concat();</span>
<span class="doccomment">/// assert_eq!(result.wait(), Ok(vec![7, 8, 9, 4, 5, 6, 1, 2, 3]));</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// It's important to note that this function will panic if the stream</span>
<span class="doccomment">/// is empty, which is the reason for its deprecation.</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">since</span><span class="op">=</span><span class="string">"0.1.14"</span>, <span class="ident">note</span><span class="op">=</span><span class="string">"please use `Stream::concat2` instead"</span>)]</span>
<span class="kw">fn</span> <span class="ident">concat</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Concat</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>,
<span class="self">Self</span>::<span class="ident">Item</span>: <span class="ident">Extend</span><span class="op"><<</span><span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Stream</span><span class="op">></span>::<span class="ident">Item</span> <span class="kw">as</span> <span class="ident">IntoIterator</span><span class="op">></span>::<span class="ident">Item</span><span class="op">></span> <span class="op">+</span> <span class="ident">IntoIterator</span>,
{
<span class="ident">concat</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Execute an accumulating computation over a stream, collecting all the</span>
<span class="doccomment">/// values into one final result.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This combinator will collect all successful results of this stream</span>
<span class="doccomment">/// according to the closure provided. The initial state is also provided to</span>
<span class="doccomment">/// this method and then is returned again by each execution of the closure.</span>
<span class="doccomment">/// Once the entire stream has been exhausted the returned future will</span>
<span class="doccomment">/// resolve to this value.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If an error happens then collected state will be dropped and the error</span>
<span class="doccomment">/// will be returned.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::stream::{self, Stream};</span>
<span class="doccomment">/// use futures::future::{ok, Future};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let number_stream = stream::iter::<_, _, ()>((0..6).map(Ok));</span>
<span class="doccomment">/// let sum = number_stream.fold(0, |acc, x| ok(acc + x));</span>
<span class="doccomment">/// assert_eq!(sum.wait(), Ok(15));</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">fold</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">T</span>, <span class="ident">Fut</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">init</span>: <span class="ident">T</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">Fold</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span>, <span class="ident">Fut</span>, <span class="ident">T</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="ident">T</span>, <span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="ident">Fut</span>,
<span class="ident">Fut</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="ident">T</span><span class="op">></span>,
<span class="self">Self</span>::<span class="ident">Error</span>: <span class="ident">From</span><span class="op"><</span><span class="ident">Fut</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">fold</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>, <span class="ident">init</span>)
}
<span class="doccomment">/// Flattens a stream of streams into just one continuous stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If this stream's elements are themselves streams then this combinator</span>
<span class="doccomment">/// will flatten out the entire stream to one long chain of elements. Any</span>
<span class="doccomment">/// errors are passed through without looking at them, but otherwise each</span>
<span class="doccomment">/// individual stream will get exhausted before moving on to the next.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::thread;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// use futures::{Future, Stream, Poll, Sink};</span>
<span class="doccomment">/// use futures::sync::mpsc;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let (tx1, rx1) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">/// let (tx2, rx2) = mpsc::channel::<i32>(1);</span>
<span class="doccomment">/// let (tx3, rx3) = mpsc::channel(1);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// thread::spawn(|| {</span>
<span class="doccomment">/// tx1.send(1).wait().unwrap()</span>
<span class="doccomment">/// .send(2).wait().unwrap();</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// thread::spawn(|| {</span>
<span class="doccomment">/// tx2.send(3).wait().unwrap()</span>
<span class="doccomment">/// .send(4).wait().unwrap();</span>
<span class="doccomment">/// });</span>
<span class="doccomment">/// thread::spawn(|| {</span>
<span class="doccomment">/// tx3.send(rx1).wait().unwrap()</span>
<span class="doccomment">/// .send(rx2).wait().unwrap();</span>
<span class="doccomment">/// });</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let mut result = rx3.flatten().collect();</span>
<span class="doccomment">/// assert_eq!(result.wait(), Ok(vec![1, 2, 3, 4]));</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">flatten</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Flatten</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>::<span class="ident">Item</span>: <span class="ident">Stream</span>,
<span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span> <span class="kw">as</span> <span class="ident">Stream</span><span class="op">></span>::<span class="ident">Error</span>: <span class="ident">From</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">flatten</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Skip elements on this stream while the predicate provided resolves to</span>
<span class="doccomment">/// `true`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function, like `Iterator::skip_while`, will skip elements on the</span>
<span class="doccomment">/// stream until the `predicate` resolves to `false`. Once one element</span>
<span class="doccomment">/// returns false all future elements will be returned from the underlying</span>
<span class="doccomment">/// stream.</span>
<span class="kw">fn</span> <span class="ident">skip_while</span><span class="op"><</span><span class="ident">P</span>, <span class="ident">R</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">pred</span>: <span class="ident">P</span>) <span class="op">-></span> <span class="ident">SkipWhile</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">P</span>, <span class="ident">R</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">P</span>: <span class="ident">FnMut</span>(<span class="kw-2">&</span><span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="ident">R</span>,
<span class="ident">R</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Item</span><span class="op">=</span><span class="ident">bool</span>, <span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">skip_while</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">pred</span>)
}
<span class="doccomment">/// Take elements from this stream while the predicate provided resolves to</span>
<span class="doccomment">/// `true`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function, like `Iterator::take_while`, will take elements from the</span>
<span class="doccomment">/// stream until the `predicate` resolves to `false`. Once one element</span>
<span class="doccomment">/// returns false it will always return that the stream is done.</span>
<span class="kw">fn</span> <span class="ident">take_while</span><span class="op"><</span><span class="ident">P</span>, <span class="ident">R</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">pred</span>: <span class="ident">P</span>) <span class="op">-></span> <span class="ident">TakeWhile</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">P</span>, <span class="ident">R</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">P</span>: <span class="ident">FnMut</span>(<span class="kw-2">&</span><span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="ident">R</span>,
<span class="ident">R</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Item</span><span class="op">=</span><span class="ident">bool</span>, <span class="ident">Error</span><span class="op">=</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">take_while</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">pred</span>)
}
<span class="doccomment">/// Runs this stream to completion, executing the provided closure for each</span>
<span class="doccomment">/// element on the stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The closure provided will be called for each item this stream resolves</span>
<span class="doccomment">/// to successfully, producing a future. That future will then be executed</span>
<span class="doccomment">/// to completion before moving on to the next item.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned value is a `Future` where the `Item` type is `()` and</span>
<span class="doccomment">/// errors are otherwise threaded through. Any error on the stream or in the</span>
<span class="doccomment">/// closure will cause iteration to be halted immediately and the future</span>
<span class="doccomment">/// will resolve to that error.</span>
<span class="kw">fn</span> <span class="ident">for_each</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">f</span>: <span class="ident">F</span>) <span class="op">-></span> <span class="ident">ForEach</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">F</span>, <span class="ident">U</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FnMut</span>(<span class="self">Self</span>::<span class="ident">Item</span>) <span class="op">-></span> <span class="ident">U</span>,
<span class="ident">U</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Item</span><span class="op">=</span>(), <span class="ident">Error</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">for_each</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">f</span>)
}
<span class="doccomment">/// Map this stream's error to any error implementing `From` for</span>
<span class="doccomment">/// this stream's `Error`, returning a new stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function does for streams what `try!` does for `Result`,</span>
<span class="doccomment">/// by letting the compiler infer the type of the resulting error.</span>
<span class="doccomment">/// Just as `map_err` above, this is useful for example to ensure</span>
<span class="doccomment">/// that streams have the same error type when used with</span>
<span class="doccomment">/// combinators.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this function consumes the receiving stream and returns a</span>
<span class="doccomment">/// wrapped version of it.</span>
<span class="kw">fn</span> <span class="ident">from_err</span><span class="op"><</span><span class="ident">E</span>: <span class="ident">From</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Error</span><span class="op">>></span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">FromErr</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">E</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>,
{
<span class="ident">from_err</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Creates a new stream of at most `amt` items of the underlying stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Once `amt` items have been yielded from this stream then it will always</span>
<span class="doccomment">/// return that the stream is done.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Any errors yielded from underlying stream, before the desired amount of</span>
<span class="doccomment">/// items is reached, are passed through and do not affect the total number</span>
<span class="doccomment">/// of items taken.</span>
<span class="kw">fn</span> <span class="ident">take</span>(<span class="self">self</span>, <span class="ident">amt</span>: <span class="ident">u64</span>) <span class="op">-></span> <span class="ident">Take</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">take</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">amt</span>)
}
<span class="doccomment">/// Creates a new stream which skips `amt` items of the underlying stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Once `amt` items have been skipped from this stream then it will always</span>
<span class="doccomment">/// return the remaining items on this stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// All errors yielded from underlying stream are passed through and do not</span>
<span class="doccomment">/// affect the total number of items skipped.</span>
<span class="kw">fn</span> <span class="ident">skip</span>(<span class="self">self</span>, <span class="ident">amt</span>: <span class="ident">u64</span>) <span class="op">-></span> <span class="ident">Skip</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">skip</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">amt</span>)
}
<span class="doccomment">/// Fuse a stream such that `poll` will never again be called once it has</span>
<span class="doccomment">/// finished.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Currently once a stream has returned `None` from `poll` any further</span>
<span class="doccomment">/// calls could exhibit bad behavior such as block forever, panic, never</span>
<span class="doccomment">/// return, etc. If it is known that `poll` may be called after stream has</span>
<span class="doccomment">/// already finished, then this method can be used to ensure that it has</span>
<span class="doccomment">/// defined semantics.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Once a stream has been `fuse`d and it finishes, then it will forever</span>
<span class="doccomment">/// return `None` from `poll`. This, unlike for the traits `poll` method,</span>
<span class="doccomment">/// is guaranteed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Also note that as soon as this stream returns `None` it will be dropped</span>
<span class="doccomment">/// to reclaim resources associated with it.</span>
<span class="kw">fn</span> <span class="ident">fuse</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Fuse</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">fuse</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Borrows a stream, rather than consuming it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is useful to allow applying stream adaptors while still retaining</span>
<span class="doccomment">/// ownership of the original stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use futures::future::{ok, Future};</span>
<span class="doccomment">/// use futures::stream::{self, Stream};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let mut stream = stream::iter::<_, _, ()>((1..5).map(Ok));</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let sum = stream.by_ref().take(2).fold(0, |a, b| ok(a + b)).wait();</span>
<span class="doccomment">/// assert_eq!(sum, Ok(3));</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // You can use the stream again</span>
<span class="doccomment">/// let sum = stream.take(2).fold(0, |a, b| ok(a + b)).wait();</span>
<span class="doccomment">/// assert_eq!(sum, Ok(7));</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">by_ref</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">Self</span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="self">self</span>
}
<span class="doccomment">/// Catches unwinding panics while polling the stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Caught panic (if any) will be the last element of the resulting stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In general, panics within a stream can propagate all the way out to the</span>
<span class="doccomment">/// task level. This combinator makes it possible to halt unwinding within</span>
<span class="doccomment">/// the stream itself. It's most commonly used within task executors. This</span>
<span class="doccomment">/// method should not be used for error handling.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this method requires the `UnwindSafe` bound from the standard</span>
<span class="doccomment">/// library. This isn't always applied automatically, and the standard</span>
<span class="doccomment">/// library provides an `AssertUnwindSafe` wrapper type to apply it</span>
<span class="doccomment">/// after-the fact. To assist using this method, the `Stream` trait is also</span>
<span class="doccomment">/// implemented for `AssertUnwindSafe<S>` where `S` implements `Stream`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// use futures::stream;</span>
<span class="doccomment">/// use futures::stream::Stream;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let stream = stream::iter::<_, Option<i32>, bool>(vec![</span>
<span class="doccomment">/// Some(10), None, Some(11)].into_iter().map(Ok));</span>
<span class="doccomment">/// // panic on second element</span>
<span class="doccomment">/// let stream_panicking = stream.map(|o| o.unwrap());</span>
<span class="doccomment">/// let mut iter = stream_panicking.catch_unwind().wait();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(Ok(10), iter.next().unwrap().ok().unwrap());</span>
<span class="doccomment">/// assert!(iter.next().unwrap().is_err());</span>
<span class="doccomment">/// assert!(iter.next().is_none());</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">catch_unwind</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">CatchUnwind</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="ident">std</span>::<span class="ident">panic</span>::<span class="ident">UnwindSafe</span>
{
<span class="ident">catch_unwind</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// An adaptor for creating a buffered list of pending futures.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If this stream's item can be converted into a future, then this adaptor</span>
<span class="doccomment">/// will buffer up to at most `amt` futures and then return results in the</span>
<span class="doccomment">/// same order as the underlying stream. No more than `amt` futures will be</span>
<span class="doccomment">/// buffered at any point in time, and less than `amt` may also be buffered</span>
<span class="doccomment">/// depending on the state of each future.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned stream will be a stream of each future's result, with</span>
<span class="doccomment">/// errors passed through whenever they occur.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">buffered</span>(<span class="self">self</span>, <span class="ident">amt</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">Buffered</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>::<span class="ident">Item</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Error</span> <span class="op">=</span> <span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Stream</span><span class="op">></span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">buffered</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">amt</span>)
}
<span class="doccomment">/// An adaptor for creating a buffered list of pending futures (unordered).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// If this stream's item can be converted into a future, then this adaptor</span>
<span class="doccomment">/// will buffer up to `amt` futures and then return results in the order</span>
<span class="doccomment">/// in which they complete. No more than `amt` futures will be buffered at</span>
<span class="doccomment">/// any point in time, and less than `amt` may also be buffered depending on</span>
<span class="doccomment">/// the state of each future.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned stream will be a stream of each future's result, with</span>
<span class="doccomment">/// errors passed through whenever they occur.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">buffer_unordered</span>(<span class="self">self</span>, <span class="ident">amt</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">BufferUnordered</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>::<span class="ident">Item</span>: <span class="ident">IntoFuture</span><span class="op"><</span><span class="ident">Error</span> <span class="op">=</span> <span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">Stream</span><span class="op">></span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">buffer_unordered</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">amt</span>)
}
<span class="doccomment">/// An adapter for merging the output of two streams.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The merged stream produces items from one or both of the underlying</span>
<span class="doccomment">/// streams as they become available. Errors, however, are not merged: you</span>
<span class="doccomment">/// get at most one error at a time.</span>
<span class="kw">fn</span> <span class="ident">merge</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">other</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="ident">Merge</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">S</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Stream</span><span class="op"><</span><span class="ident">Error</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>,
{
<span class="ident">merge</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">other</span>)
}
<span class="doccomment">/// An adapter for zipping two streams together.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The zipped stream waits for both streams to produce an item, and then</span>
<span class="doccomment">/// returns that pair. If an error happens, then that error will be returned</span>
<span class="doccomment">/// immediately. If either stream ends then the zipped stream will also end.</span>
<span class="kw">fn</span> <span class="ident">zip</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">other</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="ident">Zip</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">S</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Stream</span><span class="op"><</span><span class="ident">Error</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>,
{
<span class="ident">zip</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">other</span>)
}
<span class="doccomment">/// Adapter for chaining two stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The resulting stream emits elements from the first stream, and when</span>
<span class="doccomment">/// first stream reaches the end, emits the elements from the second stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// use futures::stream;</span>
<span class="doccomment">/// use futures::stream::Stream;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let stream1 = stream::iter(vec![Ok(10), Err(false)]);</span>
<span class="doccomment">/// let stream2 = stream::iter(vec![Err(true), Ok(20)]);</span>
<span class="doccomment">/// let mut chain = stream1.chain(stream2).wait();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(Some(Ok(10)), chain.next());</span>
<span class="doccomment">/// assert_eq!(Some(Err(false)), chain.next());</span>
<span class="doccomment">/// assert_eq!(Some(Err(true)), chain.next());</span>
<span class="doccomment">/// assert_eq!(Some(Ok(20)), chain.next());</span>
<span class="doccomment">/// assert_eq!(None, chain.next());</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">chain</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">other</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="ident">Chain</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">S</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Stream</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">chain</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">other</span>)
}
<span class="doccomment">/// Creates a new stream which exposes a `peek` method.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Calling `peek` returns a reference to the next item in the stream.</span>
<span class="kw">fn</span> <span class="ident">peekable</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Peekable</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">peek</span>::<span class="ident">new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// An adaptor for chunking up items of the stream inside a vector.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This combinator will attempt to pull items from this stream and buffer</span>
<span class="doccomment">/// them into a local vector. At most `capacity` items will get buffered</span>
<span class="doccomment">/// before they're yielded from the returned stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that the vectors returned from this iterator may not always have</span>
<span class="doccomment">/// `capacity` elements. If the underlying stream ended and only a partial</span>
<span class="doccomment">/// vector was created, it'll be returned. Additionally if an error happens</span>
<span class="doccomment">/// from the underlying stream then the currently buffered items will be</span>
<span class="doccomment">/// yielded.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Errors are passed through the stream unbuffered.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Panics</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will panic of `capacity` is zero.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">chunks</span>(<span class="self">self</span>, <span class="ident">capacity</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">Chunks</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>
<span class="kw">where</span> <span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">chunks</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">capacity</span>)
}
<span class="doccomment">/// Creates a stream that selects the next element from either this stream</span>
<span class="doccomment">/// or the provided one, whichever is ready first.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This combinator will attempt to pull items from both streams. Each</span>
<span class="doccomment">/// stream will be polled in a round-robin fashion, and whenever a stream is</span>
<span class="doccomment">/// ready to yield an item that item is yielded.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `select` function is similar to `merge` except that it requires both</span>
<span class="doccomment">/// streams to have the same item and error types.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Error are passed through from either stream.</span>
<span class="kw">fn</span> <span class="ident">select</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">other</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="ident">Select</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">S</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Stream</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Item</span>, <span class="ident">Error</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>,
{
<span class="ident">select</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">other</span>)
}
<span class="doccomment">/// A future that completes after the given stream has been fully processed</span>
<span class="doccomment">/// into the sink, including flushing.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This future will drive the stream to keep producing items until it is</span>
<span class="doccomment">/// exhausted, sending each item to the sink. It will complete once both the</span>
<span class="doccomment">/// stream is exhausted, and the sink has fully processed received item,</span>
<span class="doccomment">/// flushed successfully, and closed successfully.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Doing `stream.forward(sink)` is roughly equivalent to</span>
<span class="doccomment">/// `sink.send_all(stream)`. The returned future will exhaust all items from</span>
<span class="doccomment">/// `self`, sending them all to `sink`. Furthermore the `sink` will be</span>
<span class="doccomment">/// closed and flushed.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On completion, the pair `(stream, sink)` is returned.</span>
<span class="kw">fn</span> <span class="ident">forward</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">sink</span>: <span class="ident">S</span>) <span class="op">-></span> <span class="ident">Forward</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">S</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Sink</span><span class="op"><</span><span class="ident">SinkItem</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">Item</span><span class="op">></span>,
<span class="self">Self</span>::<span class="ident">Error</span>: <span class="ident">From</span><span class="op"><</span><span class="ident">S</span>::<span class="ident">SinkError</span><span class="op">></span>,
<span class="self">Self</span>: <span class="ident">Sized</span>
{
<span class="ident">forward</span>::<span class="ident">new</span>(<span class="self">self</span>, <span class="ident">sink</span>)
}
<span class="doccomment">/// Splits this `Stream + Sink` object into separate `Stream` and `Sink`</span>
<span class="doccomment">/// objects.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This can be useful when you want to split ownership between tasks, or</span>
<span class="doccomment">/// allow direct interaction between the two objects (e.g. via</span>
<span class="doccomment">/// `Sink::send_all`).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is only available when the `use_std` feature of this</span>
<span class="doccomment">/// library is activated, and it is activated by default.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"use_std"</span>)]</span>
<span class="kw">fn</span> <span class="ident">split</span>(<span class="self">self</span>) <span class="op">-></span> (<span class="ident">SplitSink</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>, <span class="ident">SplitStream</span><span class="op"><</span><span class="self">Self</span><span class="op">></span>)
<span class="kw">where</span> <span class="self">Self</span>: <span class="kw">super</span>::<span class="ident">sink</span>::<span class="ident">Sink</span> <span class="op">+</span> <span class="ident">Sized</span>
{
<span class="ident">split</span>::<span class="ident">split</span>(<span class="self">self</span>)
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>: <span class="question-mark">?</span><span class="ident">Sized</span> <span class="op">+</span> <span class="ident">Stream</span><span class="op">></span> <span class="ident">Stream</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">S</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">S</span>::<span class="ident">Item</span>;
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">S</span>::<span class="ident">Error</span>;
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Poll</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Item</span><span class="op">></span>, <span class="self">Self</span>::<span class="ident">Error</span><span class="op">></span> {
(<span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>).<span class="ident">poll</span>()
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "futures";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>