| <!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 `src/io/frame.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>frame.rs.html -- source</title> |
| |
| <link rel="stylesheet" type="text/css" href="../../../normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"> |
| |
| <link rel="stylesheet" type="text/css" href="../../../dark.css"> |
| <link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle"> |
| <script src="../../../storage.js"></script> |
| |
| |
| |
| |
| </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"> |
| <div class="sidebar-menu">☰</div> |
| |
| |
| </nav> |
| |
| <div class="theme-picker"> |
| <button id="theme-picker" aria-label="Pick another theme!"> |
| <img src="../../../brush.svg" width="18" alt="Pick another theme!"> |
| </button> |
| <div id="theme-choices"></div> |
| </div> |
| <script src="../../../theme.js"></script> |
| <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> |
| </pre><pre class="rust "> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">hash</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">cmp</span>; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::{<span class="ident">Deref</span>, <span class="ident">DerefMut</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>; |
| |
| <span class="kw">use</span> <span class="ident">futures</span>::{<span class="ident">Async</span>, <span class="ident">Poll</span>, <span class="ident">Stream</span>, <span class="ident">Sink</span>, <span class="ident">StartSend</span>, <span class="ident">AsyncSink</span>}; |
| |
| <span class="kw">use</span> <span class="ident">io</span>::<span class="ident">Io</span>; |
| |
| <span class="kw">const</span> <span class="ident">INITIAL_CAPACITY</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">8</span> <span class="op">*</span> <span class="number">1024</span>; |
| |
| <span class="doccomment">/// A reference counted buffer of bytes.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// An `EasyBuf` is a representation of a byte buffer where sub-slices of it can</span> |
| <span class="doccomment">/// be handed out efficiently, each with a `'static` lifetime which keeps the</span> |
| <span class="doccomment">/// data alive. The buffer also supports mutation but may require bytes to be</span> |
| <span class="doccomment">/// copied to complete the operation.</span> |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Eq</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">EasyBuf</span> { |
| <span class="ident">buf</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">>></span>, |
| <span class="ident">start</span>: <span class="ident">usize</span>, |
| <span class="ident">end</span>: <span class="ident">usize</span>, |
| } |
| |
| <span class="doccomment">/// An RAII object returned from `get_mut` which provides mutable access to the</span> |
| <span class="doccomment">/// underlying `Vec<u8>`.</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">EasyBufMut</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { |
| <span class="ident">buf</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>, |
| <span class="ident">end</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">usize</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">EasyBuf</span> { |
| <span class="doccomment">/// Creates a new EasyBuf with no data and the default capacity.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">EasyBuf</span> { |
| <span class="ident">EasyBuf</span>::<span class="ident">with_capacity</span>(<span class="ident">INITIAL_CAPACITY</span>) |
| } |
| |
| <span class="doccomment">/// Creates a new EasyBuf with `cap` capacity.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_capacity</span>(<span class="ident">cap</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">EasyBuf</span> { |
| <span class="ident">EasyBuf</span> { |
| <span class="ident">buf</span>: <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">cap</span>)), |
| <span class="ident">start</span>: <span class="number">0</span>, |
| <span class="ident">end</span>: <span class="number">0</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Changes the starting index of this window to the index specified.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Returns the windows back to chain multiple calls to this method.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will panic if `start` is out of bounds for the underlying</span> |
| <span class="doccomment">/// slice or if it comes after the `end` configured in this window.</span> |
| <span class="kw">fn</span> <span class="ident">set_start</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">start</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">EasyBuf</span> { |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">start</span> <span class="op"><=</span> <span class="self">self</span>.<span class="ident">buf</span>.<span class="ident">as_ref</span>().<span class="ident">len</span>()); |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">start</span> <span class="op"><=</span> <span class="self">self</span>.<span class="ident">end</span>); |
| <span class="self">self</span>.<span class="ident">start</span> <span class="op">=</span> <span class="ident">start</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Changes the end index of this window to the index specified.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Returns the windows back to chain multiple calls to this method.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will panic if `end` is out of bounds for the underlying</span> |
| <span class="doccomment">/// slice or if it comes after the `end` configured in this window.</span> |
| <span class="kw">fn</span> <span class="ident">set_end</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">end</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">EasyBuf</span> { |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">end</span> <span class="op"><=</span> <span class="self">self</span>.<span class="ident">buf</span>.<span class="ident">len</span>()); |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">start</span> <span class="op"><=</span> <span class="ident">end</span>); |
| <span class="self">self</span>.<span class="ident">end</span> <span class="op">=</span> <span class="ident">end</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Returns the number of bytes contained in this `EasyBuf`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">len</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">end</span> <span class="op">-</span> <span class="self">self</span>.<span class="ident">start</span> |
| } |
| |
| <span class="doccomment">/// Returns the inner contents of this `EasyBuf` as a slice.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_slice</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] { |
| <span class="self">self</span>.<span class="ident">as_ref</span>() |
| } |
| |
| <span class="doccomment">/// Splits the buffer into two at the given index.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Afterwards `self` contains elements `[0, at)`, and the returned `EasyBuf`</span> |
| <span class="doccomment">/// contains elements `[at, len)`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This is an O(1) operation that just increases the reference count and</span> |
| <span class="doccomment">/// sets a few indexes.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Panics if `at > len`</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">split_off</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">at</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">EasyBuf</span> { |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">other</span> <span class="op">=</span> <span class="ident">EasyBuf</span> { <span class="ident">buf</span>: <span class="self">self</span>.<span class="ident">buf</span>.<span class="ident">clone</span>(), ..<span class="kw-2">*</span><span class="self">self</span> }; |
| <span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">start</span> <span class="op">+</span> <span class="ident">at</span>; |
| <span class="ident">other</span>.<span class="ident">set_start</span>(<span class="ident">idx</span>); |
| <span class="self">self</span>.<span class="ident">set_end</span>(<span class="ident">idx</span>); |
| <span class="kw">return</span> <span class="ident">other</span> |
| } |
| |
| <span class="doccomment">/// Splits the buffer into two at the given index.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Afterwards `self` contains elements `[at, len)`, and the returned `EasyBuf`</span> |
| <span class="doccomment">/// contains elements `[0, at)`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This is an O(1) operation that just increases the reference count and</span> |
| <span class="doccomment">/// sets a few indexes.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// # Panics</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Panics if `at > len`</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">drain_to</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">at</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">EasyBuf</span> { |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">other</span> <span class="op">=</span> <span class="ident">EasyBuf</span> { <span class="ident">buf</span>: <span class="self">self</span>.<span class="ident">buf</span>.<span class="ident">clone</span>(), ..<span class="kw-2">*</span><span class="self">self</span> }; |
| <span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">start</span> <span class="op">+</span> <span class="ident">at</span>; |
| <span class="ident">other</span>.<span class="ident">set_end</span>(<span class="ident">idx</span>); |
| <span class="self">self</span>.<span class="ident">set_start</span>(<span class="ident">idx</span>); |
| <span class="kw">return</span> <span class="ident">other</span> |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to the underlying growable buffer of bytes.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If this `EasyBuf` is the only instance pointing at the underlying buffer</span> |
| <span class="doccomment">/// of bytes, a direct mutable reference will be returned. Otherwise the</span> |
| <span class="doccomment">/// contents of this `EasyBuf` will be reallocated in a fresh `Vec<u8>`</span> |
| <span class="doccomment">/// allocation with the same capacity as an `EasyBuf` created with `EasyBuf::new()`,</span> |
| <span class="doccomment">/// and that allocation will be returned.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This operation **is not O(1)** as it may clone the entire contents of</span> |
| <span class="doccomment">/// this buffer.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The returned `EasyBufMut` type implement `Deref` and `DerefMut` to</span> |
| <span class="doccomment">/// `Vec<u8>` can the byte buffer can be manipulated using the standard</span> |
| <span class="doccomment">/// `Vec<u8>` methods.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">EasyBufMut</span> { |
| <span class="comment">// Fast path if we can get mutable access to our own current</span> |
| <span class="comment">// buffer.</span> |
| <span class="comment">//</span> |
| <span class="comment">// TODO: this should be a match or an if-let</span> |
| <span class="kw">if</span> <span class="ident">Arc</span>::<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">buf</span>).<span class="ident">is_some</span>() { |
| <span class="kw">let</span> <span class="ident">buf</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">buf</span>).<span class="ident">unwrap</span>(); |
| <span class="ident">buf</span>.<span class="ident">drain</span>(<span class="self">self</span>.<span class="ident">end</span>..); |
| <span class="ident">buf</span>.<span class="ident">drain</span>(..<span class="self">self</span>.<span class="ident">start</span>); |
| <span class="self">self</span>.<span class="ident">start</span> <span class="op">=</span> <span class="number">0</span>; |
| <span class="kw">return</span> <span class="ident">EasyBufMut</span> { <span class="ident">buf</span>: <span class="ident">buf</span>, <span class="ident">end</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">end</span> } |
| } |
| |
| <span class="comment">// If we couldn't get access above then we give ourself a new buffer</span> |
| <span class="comment">// here.</span> |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">cmp</span>::<span class="ident">max</span>(<span class="ident">INITIAL_CAPACITY</span>, <span class="self">self</span>.<span class="ident">as_ref</span>().<span class="ident">len</span>())); |
| <span class="ident">v</span>.<span class="ident">extend_from_slice</span>(<span class="self">self</span>.<span class="ident">as_ref</span>()); |
| <span class="self">self</span>.<span class="ident">start</span> <span class="op">=</span> <span class="number">0</span>; |
| <span class="self">self</span>.<span class="ident">buf</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">v</span>); |
| <span class="ident">EasyBufMut</span> { |
| <span class="ident">buf</span>: <span class="ident">Arc</span>::<span class="ident">get_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">buf</span>).<span class="ident">unwrap</span>(), |
| <span class="ident">end</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">end</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">buf</span>[<span class="self">self</span>.<span class="ident">start</span>..<span class="self">self</span>.<span class="ident">end</span>] |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">EasyBufMut</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { |
| <span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>; |
| |
| <span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> { |
| <span class="self">self</span>.<span class="ident">buf</span> |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">DerefMut</span> <span class="kw">for</span> <span class="ident">EasyBufMut</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">deref_mut</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="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> { |
| <span class="self">self</span>.<span class="ident">buf</span> |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">>></span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>) <span class="op">-></span> <span class="ident">EasyBuf</span> { |
| <span class="kw">let</span> <span class="ident">end</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">len</span>(); |
| <span class="ident">EasyBuf</span> { |
| <span class="ident">buf</span>: <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">vec</span>), |
| <span class="ident">start</span>: <span class="number">0</span>, |
| <span class="ident">end</span>: <span class="ident">end</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">>></span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">T</span>) <span class="op">-></span> <span class="ident">bool</span> { |
| <span class="self">self</span>.<span class="ident">as_slice</span>().<span class="ident">eq</span>(<span class="ident">other</span>.<span class="ident">as_ref</span>()) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Ord</span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="self">Self</span>) <span class="op">-></span> <span class="ident">cmp</span>::<span class="ident">Ordering</span> { |
| <span class="self">self</span>.<span class="ident">as_slice</span>().<span class="ident">cmp</span>(<span class="ident">other</span>.<span class="ident">as_slice</span>()) |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">>></span> <span class="ident">PartialOrd</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">T</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">cmp</span>::<span class="ident">Ordering</span><span class="op">></span> { |
| <span class="self">self</span>.<span class="ident">as_slice</span>().<span class="ident">partial_cmp</span>(<span class="ident">other</span>.<span class="ident">as_ref</span>()) |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">hash</span>::<span class="ident">Hash</span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">hash</span><span class="op"><</span><span class="ident">H</span>: <span class="ident">hash</span>::<span class="ident">Hasher</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">state</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">H</span>) { |
| <span class="self">self</span>.<span class="ident">as_slice</span>().<span class="ident">hash</span>(<span class="ident">state</span>) |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">EasyBufMut</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> { |
| <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { |
| <span class="kw-2">*</span><span class="self">self</span>.<span class="ident">end</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">buf</span>.<span class="ident">len</span>(); |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">formatter</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { |
| <span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">as_ref</span>(); |
| <span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">len</span>(); |
| <span class="kw">if</span> <span class="ident">len</span> <span class="op"><</span> <span class="number">10</span> { |
| <span class="macro">write</span><span class="macro">!</span>(<span class="ident">formatter</span>, <span class="string">"EasyBuf{{len={}/{} {:?}}}"</span>, <span class="self">self</span>.<span class="ident">len</span>(), <span class="self">self</span>.<span class="ident">buf</span>.<span class="ident">len</span>(), <span class="ident">bytes</span>) |
| } <span class="kw">else</span> { <span class="comment">// choose a more compact representation</span> |
| <span class="macro">write</span><span class="macro">!</span>(<span class="ident">formatter</span>, <span class="string">"EasyBuf{{len={}/{} [{}, {}, {}, {}, ..., {}, {}, {}, {}]}}"</span>, <span class="self">self</span>.<span class="ident">len</span>(), <span class="self">self</span>.<span class="ident">buf</span>.<span class="ident">len</span>(), <span class="ident">bytes</span>[<span class="number">0</span>], <span class="ident">bytes</span>[<span class="number">1</span>], <span class="ident">bytes</span>[<span class="number">2</span>], <span class="ident">bytes</span>[<span class="number">3</span>], <span class="ident">bytes</span>[<span class="ident">len</span><span class="op">-</span><span class="number">4</span>], <span class="ident">bytes</span>[<span class="ident">len</span><span class="op">-</span><span class="number">3</span>], <span class="ident">bytes</span>[<span class="ident">len</span><span class="op">-</span><span class="number">2</span>], <span class="ident">bytes</span>[<span class="ident">len</span><span class="op">-</span><span class="number">1</span>]) |
| } |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">>></span> <span class="kw">for</span> <span class="ident">EasyBuf</span> { |
| <span class="kw">fn</span> <span class="ident">into</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> { |
| <span class="ident">mem</span>::<span class="ident">replace</span>(<span class="self">self</span>.<span class="ident">get_mut</span>().<span class="ident">buf</span>, <span class="macro">vec</span><span class="macro">!</span>[]) |
| } |
| } |
| |
| <span class="doccomment">/// Encoding and decoding of frames via buffers.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This trait is used when constructing an instance of `Framed`. It provides</span> |
| <span class="doccomment">/// two types: `In`, for decoded input frames, and `Out`, for outgoing frames</span> |
| <span class="doccomment">/// that need to be encoded. It also provides methods to actually perform the</span> |
| <span class="doccomment">/// encoding and decoding, which work with corresponding buffer types.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// The trait itself is implemented on a type that can track state for decoding</span> |
| <span class="doccomment">/// or encoding, which is particularly useful for streaming parsers. In many</span> |
| <span class="doccomment">/// cases, though, this type will simply be a unit struct (e.g. `struct</span> |
| <span class="doccomment">/// HttpCodec`).</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Codec</span> { |
| <span class="doccomment">/// The type of decoded frames.</span> |
| <span class="kw">type</span> <span class="ident">In</span>; |
| |
| <span class="doccomment">/// The type of frames to be encoded.</span> |
| <span class="kw">type</span> <span class="ident">Out</span>; |
| |
| <span class="doccomment">/// Attempts to decode a frame from the provided buffer of bytes.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method is called by `Framed` whenever bytes are ready to be parsed.</span> |
| <span class="doccomment">/// The provided buffer of bytes is what's been read so far, and this</span> |
| <span class="doccomment">/// instance of `Decode` can determine whether an entire frame is in the</span> |
| <span class="doccomment">/// buffer and is ready to be returned.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If an entire frame is available, then this instance will remove those</span> |
| <span class="doccomment">/// bytes from the buffer provided and return them as a decoded</span> |
| <span class="doccomment">/// frame. Note that removing bytes from the provided buffer doesn't always</span> |
| <span class="doccomment">/// necessarily copy the bytes, so this should be an efficient operation in</span> |
| <span class="doccomment">/// most circumstances.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// If the bytes look valid, but a frame isn't fully available yet, then</span> |
| <span class="doccomment">/// `Ok(None)` is returned. This indicates to the `Framed` instance that</span> |
| <span class="doccomment">/// it needs to read some more bytes before calling this method again.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Finally, if the bytes in the buffer are malformed then an error is</span> |
| <span class="doccomment">/// returned indicating why. This informs `Framed` that the stream is now</span> |
| <span class="doccomment">/// corrupt and should be terminated.</span> |
| <span class="kw">fn</span> <span class="ident">decode</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">EasyBuf</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">In</span><span class="op">>></span>; |
| |
| <span class="doccomment">/// A default method available to be called when there are no more bytes</span> |
| <span class="doccomment">/// available to be read from the underlying I/O.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method defaults to calling `decode` and returns an error if</span> |
| <span class="doccomment">/// `Ok(None)` is returned. Typically this doesn't need to be implemented</span> |
| <span class="doccomment">/// unless the framing protocol differs near the end of the stream.</span> |
| <span class="kw">fn</span> <span class="ident">decode_eof</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">buf</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">EasyBuf</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">In</span><span class="op">></span> { |
| <span class="kw">match</span> <span class="macro">try</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">decode</span>(<span class="ident">buf</span>)) { |
| <span class="prelude-val">Some</span>(<span class="ident">frame</span>) <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="ident">frame</span>), |
| <span class="prelude-val">None</span> <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">Other</span>, |
| <span class="string">"bytes remaining on stream"</span>)), |
| } |
| } |
| |
| <span class="doccomment">/// Encodes a frame into the buffer provided.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// This method will encode `msg` into the byte buffer provided by `buf`.</span> |
| <span class="doccomment">/// The `buf` provided is an internal buffer of the `Framed` instance and</span> |
| <span class="doccomment">/// will be written out when possible.</span> |
| <span class="kw">fn</span> <span class="ident">encode</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">msg</span>: <span class="self">Self</span>::<span class="ident">Out</span>, <span class="ident">buf</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>) <span class="op">-></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>; |
| } |
| |
| <span class="doccomment">/// A unified `Stream` and `Sink` interface to an underlying `Io` object, using</span> |
| <span class="doccomment">/// the `Codec` trait to encode and decode frames.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// You can acquire a `Framed` instance by using the `Io::framed` adapter.</span> |
| <span class="attribute">#[<span class="ident">must_use</span> <span class="op">=</span> <span class="string">"streams do nothing unless polled"</span>]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Framed</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">C</span><span class="op">></span> { |
| <span class="ident">upstream</span>: <span class="ident">T</span>, |
| <span class="ident">codec</span>: <span class="ident">C</span>, |
| <span class="ident">eof</span>: <span class="ident">bool</span>, |
| <span class="ident">is_readable</span>: <span class="ident">bool</span>, |
| <span class="ident">rd</span>: <span class="ident">EasyBuf</span>, |
| <span class="ident">wr</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>, |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Io</span>, <span class="ident">C</span>: <span class="ident">Codec</span><span class="op">></span> <span class="ident">Stream</span> <span class="kw">for</span> <span class="ident">Framed</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">C</span><span class="op">></span> { |
| <span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">C</span>::<span class="ident">In</span>; |
| <span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">io</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="ident">C</span>::<span class="ident">In</span><span class="op">></span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="kw">loop</span> { |
| <span class="comment">// If the read buffer has any pending data, then it could be</span> |
| <span class="comment">// possible that `decode` will return a new frame. We leave it to</span> |
| <span class="comment">// the decoder to optimize detecting that more data is required.</span> |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">is_readable</span> { |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">eof</span> { |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">rd</span>.<span class="ident">len</span>() <span class="op">==</span> <span class="number">0</span> { |
| <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>.<span class="ident">into</span>()) |
| } <span class="kw">else</span> { |
| <span class="kw">let</span> <span class="ident">frame</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">codec</span>.<span class="ident">decode_eof</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">rd</span>)); |
| <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Some</span>(<span class="ident">frame</span>))) |
| } |
| } |
| <span class="macro">trace</span><span class="macro">!</span>(<span class="string">"attempting to decode a frame"</span>); |
| <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">frame</span>) <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">codec</span>.<span class="ident">decode</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">rd</span>)) { |
| <span class="macro">trace</span><span class="macro">!</span>(<span class="string">"frame decoded from buffer"</span>); |
| <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(<span class="prelude-val">Some</span>(<span class="ident">frame</span>))); |
| } |
| <span class="self">self</span>.<span class="ident">is_readable</span> <span class="op">=</span> <span class="bool-val">false</span>; |
| } |
| |
| <span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="self">self</span>.<span class="ident">eof</span>); |
| |
| <span class="comment">// Otherwise, try to read more data and try again</span> |
| <span class="comment">//</span> |
| <span class="comment">// TODO: shouldn't read_to_end, that may read a lot</span> |
| <span class="kw">let</span> <span class="ident">before</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">rd</span>.<span class="ident">len</span>(); |
| <span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">upstream</span>.<span class="ident">read_to_end</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">rd</span>.<span class="ident">get_mut</span>()); |
| <span class="kw">match</span> <span class="ident">ret</span> { |
| <span class="prelude-val">Ok</span>(<span class="ident">_n</span>) <span class="op">=></span> <span class="self">self</span>.<span class="ident">eof</span> <span class="op">=</span> <span class="bool-val">true</span>, |
| <span class="prelude-val">Err</span>(<span class="kw-2">ref</span> <span class="ident">e</span>) <span class="kw">if</span> <span class="ident">e</span>.<span class="ident">kind</span>() <span class="op">==</span> <span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WouldBlock</span> <span class="op">=></span> { |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">rd</span>.<span class="ident">len</span>() <span class="op">==</span> <span class="ident">before</span> { |
| <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">NotReady</span>) |
| } |
| } |
| <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=></span> <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>), |
| } |
| <span class="self">self</span>.<span class="ident">is_readable</span> <span class="op">=</span> <span class="bool-val">true</span>; |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Io</span>, <span class="ident">C</span>: <span class="ident">Codec</span><span class="op">></span> <span class="ident">Sink</span> <span class="kw">for</span> <span class="ident">Framed</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">C</span><span class="op">></span> { |
| <span class="kw">type</span> <span class="ident">SinkItem</span> <span class="op">=</span> <span class="ident">C</span>::<span class="ident">Out</span>; |
| <span class="kw">type</span> <span class="ident">SinkError</span> <span class="op">=</span> <span class="ident">io</span>::<span class="ident">Error</span>; |
| |
| <span class="kw">fn</span> <span class="ident">start_send</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">item</span>: <span class="ident">C</span>::<span class="ident">Out</span>) <span class="op">-></span> <span class="ident">StartSend</span><span class="op"><</span><span class="ident">C</span>::<span class="ident">Out</span>, <span class="ident">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="comment">// If the buffer is already over 8KiB, then attempt to flush it. If after flushing it's</span> |
| <span class="comment">// *still* over 8KiB, then apply backpressure (reject the send).</span> |
| <span class="kw">const</span> <span class="ident">BACKPRESSURE_BOUNDARY</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="ident">INITIAL_CAPACITY</span>; |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">len</span>() <span class="op">></span> <span class="ident">BACKPRESSURE_BOUNDARY</span> { |
| <span class="macro">try</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">poll_complete</span>()); |
| <span class="kw">if</span> <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">len</span>() <span class="op">></span> <span class="ident">BACKPRESSURE_BOUNDARY</span> { |
| <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">AsyncSink</span>::<span class="ident">NotReady</span>(<span class="ident">item</span>)); |
| } |
| } |
| |
| <span class="macro">try</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">codec</span>.<span class="ident">encode</span>(<span class="ident">item</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">wr</span>)); |
| <span class="prelude-val">Ok</span>(<span class="ident">AsyncSink</span>::<span class="ident">Ready</span>) |
| } |
| |
| <span class="kw">fn</span> <span class="ident">poll_complete</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="ident">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="macro">trace</span><span class="macro">!</span>(<span class="string">"flushing framed transport"</span>); |
| |
| <span class="kw">while</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">is_empty</span>() { |
| <span class="macro">trace</span><span class="macro">!</span>(<span class="string">"writing; remaining={}"</span>, <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">len</span>()); |
| <span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="macro">try_nb</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">upstream</span>.<span class="ident">write</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">wr</span>)); |
| <span class="kw">if</span> <span class="ident">n</span> <span class="op">==</span> <span class="number">0</span> { |
| <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">WriteZero</span>, |
| <span class="string">"failed to write frame to transport"</span>)); |
| } |
| <span class="self">self</span>.<span class="ident">wr</span>.<span class="ident">drain</span>(..<span class="ident">n</span>); |
| } |
| |
| <span class="comment">// Try flushing the underlying IO</span> |
| <span class="macro">try_nb</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">upstream</span>.<span class="ident">flush</span>()); |
| |
| <span class="macro">trace</span><span class="macro">!</span>(<span class="string">"framed transport flushed"</span>); |
| <span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">Async</span>::<span class="ident">Ready</span>(())); |
| } |
| |
| <span class="kw">fn</span> <span class="ident">close</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="ident">io</span>::<span class="ident">Error</span><span class="op">></span> { |
| <span class="macro">try_ready</span><span class="macro">!</span>(<span class="self">self</span>.<span class="ident">poll_complete</span>()); |
| <span class="prelude-val">Ok</span>(().<span class="ident">into</span>()) |
| } |
| } |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">framed</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">C</span><span class="op">></span>(<span class="ident">io</span>: <span class="ident">T</span>, <span class="ident">codec</span>: <span class="ident">C</span>) <span class="op">-></span> <span class="ident">Framed</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">C</span><span class="op">></span> { |
| <span class="ident">Framed</span> { |
| <span class="ident">upstream</span>: <span class="ident">io</span>, |
| <span class="ident">codec</span>: <span class="ident">codec</span>, |
| <span class="ident">eof</span>: <span class="bool-val">false</span>, |
| <span class="ident">is_readable</span>: <span class="bool-val">false</span>, |
| <span class="ident">rd</span>: <span class="ident">EasyBuf</span>::<span class="ident">new</span>(), |
| <span class="ident">wr</span>: <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">INITIAL_CAPACITY</span>), |
| } |
| } |
| |
| <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">C</span><span class="op">></span> <span class="ident">Framed</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">C</span><span class="op">></span> { |
| |
| <span class="doccomment">/// Returns a reference to the underlying I/O stream wrapped by `Framed`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that care should be taken to not tamper with the underlying stream</span> |
| <span class="doccomment">/// of data coming in as it may corrupt the stream of frames otherwise being</span> |
| <span class="doccomment">/// worked with.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">T</span> { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">upstream</span> |
| } |
| |
| <span class="doccomment">/// Returns a mutable reference to the underlying I/O stream wrapped by</span> |
| <span class="doccomment">/// `Framed`.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that care should be taken to not tamper with the underlying stream</span> |
| <span class="doccomment">/// of data coming in as it may corrupt the stream of frames otherwise being</span> |
| <span class="doccomment">/// worked with.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_mut</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="ident">T</span> { |
| <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">upstream</span> |
| } |
| |
| <span class="doccomment">/// Consumes the `Framed`, returning its underlying I/O stream.</span> |
| <span class="doccomment">///</span> |
| <span class="doccomment">/// Note that care should be taken to not tamper with the underlying stream</span> |
| <span class="doccomment">/// of data coming in as it may corrupt the stream of frames otherwise being</span> |
| <span class="doccomment">/// worked with.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">T</span> { |
| <span class="self">self</span>.<span class="ident">upstream</span> |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span> |
| <span class="kw">mod</span> <span class="ident">tests</span> { |
| <span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">INITIAL_CAPACITY</span>, <span class="ident">EasyBuf</span>}; |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>; |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">debug_empty_easybuf</span>() { |
| <span class="kw">let</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[].<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"EasyBuf{len=0/0 []}"</span>, <span class="macro">format</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">buf</span>)); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">debug_small_easybuf</span>() { |
| <span class="kw">let</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>].<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"EasyBuf{len=6/6 [1, 2, 3, 4, 5, 6]}"</span>, <span class="macro">format</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">buf</span>)); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">debug_small_easybuf_split</span>() { |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>].<span class="ident">into</span>(); |
| <span class="kw">let</span> <span class="ident">split</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">split_off</span>(<span class="number">4</span>); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"EasyBuf{len=4/6 [1, 2, 3, 4]}"</span>, <span class="macro">format</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">buf</span>)); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"EasyBuf{len=2/6 [5, 6]}"</span>, <span class="macro">format</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">split</span>)); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">debug_large_easybuf</span>() { |
| <span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">255u8</span>).<span class="ident">collect</span>(); |
| <span class="kw">let</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"EasyBuf{len=255/255 [0, 1, 2, 3, ..., 251, 252, 253, 254]}"</span>, <span class="macro">format</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">buf</span>)); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_get_mut_sliced</span>() { |
| <span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10u8</span>).<span class="ident">collect</span>(); |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">into</span>(); |
| <span class="ident">buf</span>.<span class="ident">split_off</span>(<span class="number">9</span>); |
| <span class="ident">buf</span>.<span class="ident">drain_to</span>(<span class="number">3</span>); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">buf</span>.<span class="ident">get_mut</span>(), [<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>]); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_get_mut_sliced_allocating_at_least_initial_capacity</span>() { |
| <span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10u8</span>).<span class="ident">collect</span>(); |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">into</span>(); |
| <span class="ident">buf</span>.<span class="ident">split_off</span>(<span class="number">9</span>); |
| <span class="ident">buf</span>.<span class="ident">drain_to</span>(<span class="number">3</span>); |
| <span class="comment">// Clone to make shared</span> |
| <span class="kw">let</span> <span class="ident">clone</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">clone</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="ident">buf</span>.<span class="ident">get_mut</span>(), [<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>]); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">get_mut</span>().<span class="ident">buf</span>.<span class="ident">capacity</span>(), <span class="ident">INITIAL_CAPACITY</span>); |
| <span class="ident">mem</span>::<span class="ident">drop</span>(<span class="ident">clone</span>); <span class="comment">// prevent unused warning</span> |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_get_mut_sliced_allocating_required_capacity</span>() { |
| <span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">0</span>..<span class="ident">INITIAL_CAPACITY</span> <span class="op">*</span> <span class="number">2</span>).<span class="ident">map</span>(<span class="op">|</span>_<span class="op">|</span><span class="number">0u8</span>).<span class="ident">collect</span>(); |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">into</span>(); |
| <span class="ident">buf</span>.<span class="ident">drain_to</span>(<span class="ident">INITIAL_CAPACITY</span> <span class="op">/</span> <span class="number">2</span>); |
| <span class="kw">let</span> <span class="ident">clone</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">clone</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>.<span class="ident">get_mut</span>().<span class="ident">buf</span>.<span class="ident">capacity</span>(), <span class="ident">INITIAL_CAPACITY</span> <span class="op">+</span> <span class="ident">INITIAL_CAPACITY</span> <span class="op">/</span> <span class="number">2</span>); |
| <span class="ident">mem</span>::<span class="ident">drop</span>(<span class="ident">clone</span>) |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_into_vec_simple</span>() { |
| <span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10u8</span>).<span class="ident">collect</span>(); |
| <span class="kw">let</span> <span class="ident">reference</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">clone</span>(); |
| <span class="kw">let</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">into</span>(); |
| <span class="kw">let</span> <span class="ident">original_pointer</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">buf</span>.<span class="ident">as_ref</span>().<span class="ident">as_ptr</span>(); |
| <span class="kw">let</span> <span class="ident">result</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>, <span class="ident">reference</span>); |
| <span class="kw">let</span> <span class="ident">new_pointer</span> <span class="op">=</span> <span class="ident">result</span>.<span class="ident">as_ptr</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">original_pointer</span>, <span class="ident">new_pointer</span>, <span class="string">"Into<Vec<u8>> should reuse the exclusive Vec"</span>); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_into_vec_sliced</span>() { |
| <span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10u8</span>).<span class="ident">collect</span>(); |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">into</span>(); |
| <span class="kw">let</span> <span class="ident">original_pointer</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">buf</span>.<span class="ident">as_ref</span>().<span class="ident">as_ptr</span>(); |
| <span class="ident">buf</span>.<span class="ident">split_off</span>(<span class="number">9</span>); |
| <span class="ident">buf</span>.<span class="ident">drain_to</span>(<span class="number">3</span>); |
| <span class="kw">let</span> <span class="ident">result</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">into</span>(); |
| <span class="kw">let</span> <span class="ident">reference</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">3u8</span>..<span class="number">9u8</span>).<span class="ident">collect</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>, <span class="ident">reference</span>); |
| <span class="kw">let</span> <span class="ident">new_pointer</span> <span class="op">=</span> <span class="ident">result</span>.<span class="ident">as_ptr</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">original_pointer</span>, <span class="ident">new_pointer</span>, <span class="string">"Into<Vec<u8>> should reuse the exclusive Vec"</span>); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_into_vec_sliced_allocating</span>() { |
| <span class="kw">let</span> <span class="ident">vec</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10u8</span>).<span class="ident">collect</span>(); |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">into</span>(); |
| <span class="kw">let</span> <span class="ident">original_pointer</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">buf</span>.<span class="ident">as_ref</span>().<span class="ident">as_ptr</span>(); |
| <span class="comment">// Create a clone to create second reference to this EasyBuf and force allocation</span> |
| <span class="kw">let</span> <span class="ident">original</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">clone</span>(); |
| <span class="ident">buf</span>.<span class="ident">split_off</span>(<span class="number">9</span>); |
| <span class="ident">buf</span>.<span class="ident">drain_to</span>(<span class="number">3</span>); |
| <span class="kw">let</span> <span class="ident">result</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">into</span>(); |
| <span class="kw">let</span> <span class="ident">reference</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> (<span class="number">3u8</span>..<span class="number">9u8</span>).<span class="ident">collect</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">result</span>, <span class="ident">reference</span>); |
| <span class="kw">let</span> <span class="ident">original_reference</span>: <span class="ident">EasyBuf</span> <span class="op">=</span>(<span class="number">0u8</span>..<span class="number">10u8</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">>></span>().<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">original</span>.<span class="ident">as_ref</span>(), <span class="ident">original_reference</span>.<span class="ident">as_ref</span>()); |
| <span class="kw">let</span> <span class="ident">new_pointer</span> <span class="op">=</span> <span class="ident">result</span>.<span class="ident">as_ptr</span>(); |
| <span class="macro">assert_ne</span><span class="macro">!</span>(<span class="ident">original_pointer</span>, <span class="ident">new_pointer</span>, <span class="string">"A new vec should be allocated"</span>); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_equality_same_underlying_vec</span>() { |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span>_<span class="op">>></span>().<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="ident">buf</span>); |
| <span class="kw">let</span> <span class="ident">other</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">drain_to</span>(<span class="number">5</span>); |
| <span class="macro">assert_ne</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="ident">other</span>); |
| |
| <span class="kw">let</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">5</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span>_<span class="op">>></span>().<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="ident">other</span>); |
| } |
| |
| <span class="attribute">#[<span class="ident">test</span>]</span> |
| <span class="kw">fn</span> <span class="ident">easybuf_equality_different_underlying_vec</span>() { |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span>_<span class="op">>></span>().<span class="ident">into</span>(); |
| <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">other</span>: <span class="ident">EasyBuf</span> <span class="op">=</span> (<span class="number">0u8</span>..<span class="number">10</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span>_<span class="op">>></span>().<span class="ident">into</span>(); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="ident">other</span>); |
| |
| <span class="ident">buf</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">drain_to</span>(<span class="number">5</span>); |
| <span class="macro">assert_ne</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="ident">other</span>); |
| |
| <span class="ident">other</span> <span class="op">=</span> <span class="ident">other</span>.<span class="ident">drain_to</span>(<span class="number">5</span>); |
| <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="ident">other</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><kbd>?</kbd></dt> |
| <dd>Show this help dialog</dd> |
| <dt><kbd>S</kbd></dt> |
| <dd>Focus the search field</dd> |
| <dt><kbd>↑</kbd></dt> |
| <dd>Move up in search results</dd> |
| <dt><kbd>↓</kbd></dt> |
| <dd>Move down in search results</dd> |
| <dt><kbd>↹</kbd></dt> |
| <dd>Switch tab</dd> |
| <dt><kbd>⏎</kbd></dt> |
| <dd>Go to active search result</dd> |
| <dt><kbd>+</kbd></dt> |
| <dd>Expand all sections</dd> |
| <dt><kbd>-</kbd></dt> |
| <dd>Collapse 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 = "tokio_core"; |
| </script> |
| <script src="../../../main.js"></script> |
| <script defer src="../../../search-index.js"></script> |
| </body> |
| </html> |
