blob: 0d8accc7c010bddeb4e7fa9c47e97dc1cf0e99e0 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/base64-0.13.1/src/encode.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>encode.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../base64/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../base64/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
</pre><pre class="rust"><code><span class="kw">use crate</span>::{Config, PAD_BYTE};
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;alloc&quot;</span>, feature = <span class="string">&quot;std&quot;</span>, test))]
</span><span class="kw">use crate</span>::{chunked_encoder, STANDARD};
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;alloc&quot;</span>, feature = <span class="string">&quot;std&quot;</span>, test))]
</span><span class="kw">use </span>alloc::{string::String, vec};
<span class="kw">use </span>core::convert::TryInto;
<span class="doccomment">///Encode arbitrary octets as base64.
///Returns a String.
///Convenience for `encode_config(input, base64::STANDARD);`.
///
///# Example
///
///```rust
///extern crate base64;
///
///fn main() {
/// let b64 = base64::encode(b&quot;hello world&quot;);
/// println!(&quot;{}&quot;, b64);
///}
///```
</span><span class="attribute">#[cfg(any(feature = <span class="string">&quot;alloc&quot;</span>, feature = <span class="string">&quot;std&quot;</span>, test))]
</span><span class="kw">pub fn </span>encode&lt;T: AsRef&lt;[u8]&gt;&gt;(input: T) -&gt; String {
encode_config(input, STANDARD)
}
<span class="doccomment">///Encode arbitrary octets as base64.
///Returns a String.
///
///# Example
///
///```rust
///extern crate base64;
///
///fn main() {
/// let b64 = base64::encode_config(b&quot;hello world~&quot;, base64::STANDARD);
/// println!(&quot;{}&quot;, b64);
///
/// let b64_url = base64::encode_config(b&quot;hello internet~&quot;, base64::URL_SAFE);
/// println!(&quot;{}&quot;, b64_url);
///}
///```
</span><span class="attribute">#[cfg(any(feature = <span class="string">&quot;alloc&quot;</span>, feature = <span class="string">&quot;std&quot;</span>, test))]
</span><span class="kw">pub fn </span>encode_config&lt;T: AsRef&lt;[u8]&gt;&gt;(input: T, config: Config) -&gt; String {
<span class="kw">let </span><span class="kw-2">mut </span>buf = <span class="kw">match </span>encoded_size(input.as_ref().len(), config) {
<span class="prelude-val">Some</span>(n) =&gt; <span class="macro">vec!</span>[<span class="number">0</span>; n],
<span class="prelude-val">None </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;integer overflow when calculating buffer size&quot;</span>),
};
encode_with_padding(input.as_ref(), config, buf.len(), <span class="kw-2">&amp;mut </span>buf[..]);
String::from_utf8(buf).expect(<span class="string">&quot;Invalid UTF8&quot;</span>)
}
<span class="doccomment">///Encode arbitrary octets as base64.
///Writes into the supplied output buffer, which will grow the buffer if needed.
///
///# Example
///
///```rust
///extern crate base64;
///
///fn main() {
/// let mut buf = String::new();
/// base64::encode_config_buf(b&quot;hello world~&quot;, base64::STANDARD, &amp;mut buf);
/// println!(&quot;{}&quot;, buf);
///
/// buf.clear();
/// base64::encode_config_buf(b&quot;hello internet~&quot;, base64::URL_SAFE, &amp;mut buf);
/// println!(&quot;{}&quot;, buf);
///}
///```
</span><span class="attribute">#[cfg(any(feature = <span class="string">&quot;alloc&quot;</span>, feature = <span class="string">&quot;std&quot;</span>, test))]
</span><span class="kw">pub fn </span>encode_config_buf&lt;T: AsRef&lt;[u8]&gt;&gt;(input: T, config: Config, buf: <span class="kw-2">&amp;mut </span>String) {
<span class="kw">let </span>input_bytes = input.as_ref();
{
<span class="kw">let </span><span class="kw-2">mut </span>sink = chunked_encoder::StringSink::new(buf);
<span class="kw">let </span>encoder = chunked_encoder::ChunkedEncoder::new(config);
encoder
.encode(input_bytes, <span class="kw-2">&amp;mut </span>sink)
.expect(<span class="string">&quot;Writing to a String shouldn&#39;t fail&quot;</span>)
}
}
<span class="doccomment">/// Encode arbitrary octets as base64.
/// Writes into the supplied output buffer.
///
/// This is useful if you wish to avoid allocation entirely (e.g. encoding into a stack-resident
/// or statically-allocated buffer).
///
/// # Panics
///
/// If `output` is too small to hold the encoded version of `input`, a panic will result.
///
/// # Example
///
/// ```rust
/// extern crate base64;
///
/// fn main() {
/// let s = b&quot;hello internet!&quot;;
/// let mut buf = Vec::new();
/// // make sure we&#39;ll have a slice big enough for base64 + padding
/// buf.resize(s.len() * 4 / 3 + 4, 0);
///
/// let bytes_written = base64::encode_config_slice(s,
/// base64::STANDARD, &amp;mut buf);
///
/// // shorten our vec down to just what was written
/// buf.resize(bytes_written, 0);
///
/// assert_eq!(s, base64::decode(&amp;buf).unwrap().as_slice());
/// }
/// ```
</span><span class="kw">pub fn </span>encode_config_slice&lt;T: AsRef&lt;[u8]&gt;&gt;(input: T, config: Config, output: <span class="kw-2">&amp;mut </span>[u8]) -&gt; usize {
<span class="kw">let </span>input_bytes = input.as_ref();
<span class="kw">let </span>encoded_size = encoded_size(input_bytes.len(), config)
.expect(<span class="string">&quot;usize overflow when calculating buffer size&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>b64_output = <span class="kw-2">&amp;mut </span>output[<span class="number">0</span>..encoded_size];
encode_with_padding(<span class="kw-2">&amp;</span>input_bytes, config, encoded_size, <span class="kw-2">&amp;mut </span>b64_output);
encoded_size
}
<span class="doccomment">/// B64-encode and pad (if configured).
///
/// This helper exists to avoid recalculating encoded_size, which is relatively expensive on short
/// inputs.
///
/// `encoded_size` is the encoded size calculated for `input`.
///
/// `output` must be of size `encoded_size`.
///
/// All bytes in `output` will be written to since it is exactly the size of the output.
</span><span class="kw">fn </span>encode_with_padding(input: <span class="kw-2">&amp;</span>[u8], config: Config, encoded_size: usize, output: <span class="kw-2">&amp;mut </span>[u8]) {
<span class="macro">debug_assert_eq!</span>(encoded_size, output.len());
<span class="kw">let </span>b64_bytes_written = encode_to_slice(input, output, config.char_set.encode_table());
<span class="kw">let </span>padding_bytes = <span class="kw">if </span>config.pad {
add_padding(input.len(), <span class="kw-2">&amp;mut </span>output[b64_bytes_written..])
} <span class="kw">else </span>{
<span class="number">0
</span>};
<span class="kw">let </span>encoded_bytes = b64_bytes_written
.checked_add(padding_bytes)
.expect(<span class="string">&quot;usize overflow when calculating b64 length&quot;</span>);
<span class="macro">debug_assert_eq!</span>(encoded_size, encoded_bytes);
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>read_u64(s: <span class="kw-2">&amp;</span>[u8]) -&gt; u64 {
u64::from_be_bytes(s[..<span class="number">8</span>].try_into().unwrap())
}
<span class="doccomment">/// Encode input bytes to utf8 base64 bytes. Does not pad.
/// `output` must be long enough to hold the encoded `input` without padding.
/// Returns the number of bytes written.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>encode_to_slice(input: <span class="kw-2">&amp;</span>[u8], output: <span class="kw-2">&amp;mut </span>[u8], encode_table: <span class="kw-2">&amp;</span>[u8; <span class="number">64</span>]) -&gt; usize {
<span class="kw">let </span><span class="kw-2">mut </span>input_index: usize = <span class="number">0</span>;
<span class="kw">const </span>BLOCKS_PER_FAST_LOOP: usize = <span class="number">4</span>;
<span class="kw">const </span>LOW_SIX_BITS: u64 = <span class="number">0x3F</span>;
<span class="comment">// we read 8 bytes at a time (u64) but only actually consume 6 of those bytes. Thus, we need
// 2 trailing bytes to be available to read..
</span><span class="kw">let </span>last_fast_index = input.len().saturating_sub(BLOCKS_PER_FAST_LOOP * <span class="number">6 </span>+ <span class="number">2</span>);
<span class="kw">let </span><span class="kw-2">mut </span>output_index = <span class="number">0</span>;
<span class="kw">if </span>last_fast_index &gt; <span class="number">0 </span>{
<span class="kw">while </span>input_index &lt;= last_fast_index {
<span class="comment">// Major performance wins from letting the optimizer do the bounds check once, mostly
// on the output side
</span><span class="kw">let </span>input_chunk = <span class="kw-2">&amp;</span>input[input_index..(input_index + (BLOCKS_PER_FAST_LOOP * <span class="number">6 </span>+ <span class="number">2</span>))];
<span class="kw">let </span>output_chunk = <span class="kw-2">&amp;mut </span>output[output_index..(output_index + BLOCKS_PER_FAST_LOOP * <span class="number">8</span>)];
<span class="comment">// Hand-unrolling for 32 vs 16 or 8 bytes produces yields performance about equivalent
// to unsafe pointer code on a Xeon E5-1650v3. 64 byte unrolling was slightly better for
// large inputs but significantly worse for 50-byte input, unsurprisingly. I suspect
// that it&#39;s a not uncommon use case to encode smallish chunks of data (e.g. a 64-byte
// SHA-512 digest), so it would be nice if that fit in the unrolled loop at least once.
// Plus, single-digit percentage performance differences might well be quite different
// on different hardware.
</span><span class="kw">let </span>input_u64 = read_u64(<span class="kw-2">&amp;</span>input_chunk[<span class="number">0</span>..]);
output_chunk[<span class="number">0</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">58</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">1</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">52</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">2</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">46</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">3</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">40</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">4</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">34</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">5</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">28</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">6</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">22</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">7</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">16</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
<span class="kw">let </span>input_u64 = read_u64(<span class="kw-2">&amp;</span>input_chunk[<span class="number">6</span>..]);
output_chunk[<span class="number">8</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">58</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">9</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">52</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">10</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">46</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">11</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">40</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">12</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">34</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">13</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">28</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">14</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">22</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">15</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">16</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
<span class="kw">let </span>input_u64 = read_u64(<span class="kw-2">&amp;</span>input_chunk[<span class="number">12</span>..]);
output_chunk[<span class="number">16</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">58</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">17</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">52</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">18</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">46</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">19</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">40</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">20</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">34</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">21</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">28</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">22</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">22</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">23</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">16</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
<span class="kw">let </span>input_u64 = read_u64(<span class="kw-2">&amp;</span>input_chunk[<span class="number">18</span>..]);
output_chunk[<span class="number">24</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">58</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">25</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">52</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">26</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">46</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">27</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">40</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">28</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">34</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">29</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">28</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">30</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">22</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_chunk[<span class="number">31</span>] = encode_table[((input_u64 &gt;&gt; <span class="number">16</span>) &amp; LOW_SIX_BITS) <span class="kw">as </span>usize];
output_index += BLOCKS_PER_FAST_LOOP * <span class="number">8</span>;
input_index += BLOCKS_PER_FAST_LOOP * <span class="number">6</span>;
}
}
<span class="comment">// Encode what&#39;s left after the fast loop.
</span><span class="kw">const </span>LOW_SIX_BITS_U8: u8 = <span class="number">0x3F</span>;
<span class="kw">let </span>rem = input.len() % <span class="number">3</span>;
<span class="kw">let </span>start_of_rem = input.len() - rem;
<span class="comment">// start at the first index not handled by fast loop, which may be 0.
</span><span class="kw">while </span>input_index &lt; start_of_rem {
<span class="kw">let </span>input_chunk = <span class="kw-2">&amp;</span>input[input_index..(input_index + <span class="number">3</span>)];
<span class="kw">let </span>output_chunk = <span class="kw-2">&amp;mut </span>output[output_index..(output_index + <span class="number">4</span>)];
output_chunk[<span class="number">0</span>] = encode_table[(input_chunk[<span class="number">0</span>] &gt;&gt; <span class="number">2</span>) <span class="kw">as </span>usize];
output_chunk[<span class="number">1</span>] =
encode_table[((input_chunk[<span class="number">0</span>] &lt;&lt; <span class="number">4 </span>| input_chunk[<span class="number">1</span>] &gt;&gt; <span class="number">4</span>) &amp; LOW_SIX_BITS_U8) <span class="kw">as </span>usize];
output_chunk[<span class="number">2</span>] =
encode_table[((input_chunk[<span class="number">1</span>] &lt;&lt; <span class="number">2 </span>| input_chunk[<span class="number">2</span>] &gt;&gt; <span class="number">6</span>) &amp; LOW_SIX_BITS_U8) <span class="kw">as </span>usize];
output_chunk[<span class="number">3</span>] = encode_table[(input_chunk[<span class="number">2</span>] &amp; LOW_SIX_BITS_U8) <span class="kw">as </span>usize];
input_index += <span class="number">3</span>;
output_index += <span class="number">4</span>;
}
<span class="kw">if </span>rem == <span class="number">2 </span>{
output[output_index] = encode_table[(input[start_of_rem] &gt;&gt; <span class="number">2</span>) <span class="kw">as </span>usize];
output[output_index + <span class="number">1</span>] = encode_table[((input[start_of_rem] &lt;&lt; <span class="number">4
</span>| input[start_of_rem + <span class="number">1</span>] &gt;&gt; <span class="number">4</span>)
&amp; LOW_SIX_BITS_U8) <span class="kw">as </span>usize];
output[output_index + <span class="number">2</span>] =
encode_table[((input[start_of_rem + <span class="number">1</span>] &lt;&lt; <span class="number">2</span>) &amp; LOW_SIX_BITS_U8) <span class="kw">as </span>usize];
output_index += <span class="number">3</span>;
} <span class="kw">else if </span>rem == <span class="number">1 </span>{
output[output_index] = encode_table[(input[start_of_rem] &gt;&gt; <span class="number">2</span>) <span class="kw">as </span>usize];
output[output_index + <span class="number">1</span>] =
encode_table[((input[start_of_rem] &lt;&lt; <span class="number">4</span>) &amp; LOW_SIX_BITS_U8) <span class="kw">as </span>usize];
output_index += <span class="number">2</span>;
}
output_index
}
<span class="doccomment">/// calculate the base64 encoded string size, including padding if appropriate
</span><span class="kw">pub fn </span>encoded_size(bytes_len: usize, config: Config) -&gt; <span class="prelude-ty">Option</span>&lt;usize&gt; {
<span class="kw">let </span>rem = bytes_len % <span class="number">3</span>;
<span class="kw">let </span>complete_input_chunks = bytes_len / <span class="number">3</span>;
<span class="kw">let </span>complete_chunk_output = complete_input_chunks.checked_mul(<span class="number">4</span>);
<span class="kw">if </span>rem &gt; <span class="number">0 </span>{
<span class="kw">if </span>config.pad {
complete_chunk_output.and_then(|c| c.checked_add(<span class="number">4</span>))
} <span class="kw">else </span>{
<span class="kw">let </span>encoded_rem = <span class="kw">match </span>rem {
<span class="number">1 </span>=&gt; <span class="number">2</span>,
<span class="number">2 </span>=&gt; <span class="number">3</span>,
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(<span class="string">&quot;Impossible remainder&quot;</span>),
};
complete_chunk_output.and_then(|c| c.checked_add(encoded_rem))
}
} <span class="kw">else </span>{
complete_chunk_output
}
}
<span class="doccomment">/// Write padding characters.
/// `output` is the slice where padding should be written, of length at least 2.
///
/// Returns the number of padding bytes written.
</span><span class="kw">pub fn </span>add_padding(input_len: usize, output: <span class="kw-2">&amp;mut </span>[u8]) -&gt; usize {
<span class="kw">let </span>rem = input_len % <span class="number">3</span>;
<span class="kw">let </span><span class="kw-2">mut </span>bytes_written = <span class="number">0</span>;
<span class="kw">for _ in </span><span class="number">0</span>..((<span class="number">3 </span>- rem) % <span class="number">3</span>) {
output[bytes_written] = PAD_BYTE;
bytes_written += <span class="number">1</span>;
}
bytes_written
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use crate</span>::{
decode::decode_config_buf,
tests::{assert_encode_sanity, random_config},
Config, STANDARD, URL_SAFE_NO_PAD,
};
<span class="kw">use </span>rand::{
distributions::{Distribution, Uniform},
FromEntropy, Rng,
};
<span class="kw">use </span>std;
<span class="kw">use </span>std::str;
<span class="attribute">#[test]
</span><span class="kw">fn </span>encoded_size_correct_standard() {
assert_encoded_length(<span class="number">0</span>, <span class="number">0</span>, STANDARD);
assert_encoded_length(<span class="number">1</span>, <span class="number">4</span>, STANDARD);
assert_encoded_length(<span class="number">2</span>, <span class="number">4</span>, STANDARD);
assert_encoded_length(<span class="number">3</span>, <span class="number">4</span>, STANDARD);
assert_encoded_length(<span class="number">4</span>, <span class="number">8</span>, STANDARD);
assert_encoded_length(<span class="number">5</span>, <span class="number">8</span>, STANDARD);
assert_encoded_length(<span class="number">6</span>, <span class="number">8</span>, STANDARD);
assert_encoded_length(<span class="number">7</span>, <span class="number">12</span>, STANDARD);
assert_encoded_length(<span class="number">8</span>, <span class="number">12</span>, STANDARD);
assert_encoded_length(<span class="number">9</span>, <span class="number">12</span>, STANDARD);
assert_encoded_length(<span class="number">54</span>, <span class="number">72</span>, STANDARD);
assert_encoded_length(<span class="number">55</span>, <span class="number">76</span>, STANDARD);
assert_encoded_length(<span class="number">56</span>, <span class="number">76</span>, STANDARD);
assert_encoded_length(<span class="number">57</span>, <span class="number">76</span>, STANDARD);
assert_encoded_length(<span class="number">58</span>, <span class="number">80</span>, STANDARD);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encoded_size_correct_no_pad() {
assert_encoded_length(<span class="number">0</span>, <span class="number">0</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">1</span>, <span class="number">2</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">2</span>, <span class="number">3</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">3</span>, <span class="number">4</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">4</span>, <span class="number">6</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">5</span>, <span class="number">7</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">6</span>, <span class="number">8</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">7</span>, <span class="number">10</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">8</span>, <span class="number">11</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">9</span>, <span class="number">12</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">54</span>, <span class="number">72</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">55</span>, <span class="number">74</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">56</span>, <span class="number">75</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">57</span>, <span class="number">76</span>, URL_SAFE_NO_PAD);
assert_encoded_length(<span class="number">58</span>, <span class="number">78</span>, URL_SAFE_NO_PAD);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encoded_size_overflow() {
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, encoded_size(std::usize::MAX, STANDARD));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encode_config_buf_into_nonempty_buffer_doesnt_clobber_prefix() {
<span class="kw">let </span><span class="kw-2">mut </span>orig_data = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>prefix = String::new();
<span class="kw">let </span><span class="kw-2">mut </span>encoded_data_no_prefix = String::new();
<span class="kw">let </span><span class="kw-2">mut </span>encoded_data_with_prefix = String::new();
<span class="kw">let </span><span class="kw-2">mut </span>decoded = Vec::new();
<span class="kw">let </span>prefix_len_range = Uniform::new(<span class="number">0</span>, <span class="number">1000</span>);
<span class="kw">let </span>input_len_range = Uniform::new(<span class="number">0</span>, <span class="number">1000</span>);
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10_000 </span>{
orig_data.clear();
prefix.clear();
encoded_data_no_prefix.clear();
encoded_data_with_prefix.clear();
decoded.clear();
<span class="kw">let </span>input_len = input_len_range.sample(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">for _ in </span><span class="number">0</span>..input_len {
orig_data.push(rng.gen());
}
<span class="kw">let </span>prefix_len = prefix_len_range.sample(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">for _ in </span><span class="number">0</span>..prefix_len {
<span class="comment">// getting convenient random single-byte printable chars that aren&#39;t base64 is
// annoying
</span>prefix.push(<span class="string">&#39;#&#39;</span>);
}
encoded_data_with_prefix.push_str(<span class="kw-2">&amp;</span>prefix);
<span class="kw">let </span>config = random_config(<span class="kw-2">&amp;mut </span>rng);
encode_config_buf(<span class="kw-2">&amp;</span>orig_data, config, <span class="kw-2">&amp;mut </span>encoded_data_no_prefix);
encode_config_buf(<span class="kw-2">&amp;</span>orig_data, config, <span class="kw-2">&amp;mut </span>encoded_data_with_prefix);
<span class="macro">assert_eq!</span>(
encoded_data_no_prefix.len() + prefix_len,
encoded_data_with_prefix.len()
);
assert_encode_sanity(<span class="kw-2">&amp;</span>encoded_data_no_prefix, config, input_len);
assert_encode_sanity(<span class="kw-2">&amp;</span>encoded_data_with_prefix[prefix_len..], config, input_len);
<span class="comment">// append plain encode onto prefix
</span>prefix.push_str(<span class="kw-2">&amp;mut </span>encoded_data_no_prefix);
<span class="macro">assert_eq!</span>(prefix, encoded_data_with_prefix);
decode_config_buf(<span class="kw-2">&amp;</span>encoded_data_no_prefix, config, <span class="kw-2">&amp;mut </span>decoded).unwrap();
<span class="macro">assert_eq!</span>(orig_data, decoded);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encode_config_slice_into_nonempty_buffer_doesnt_clobber_suffix() {
<span class="kw">let </span><span class="kw-2">mut </span>orig_data = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>encoded_data = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>encoded_data_original_state = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>decoded = Vec::new();
<span class="kw">let </span>input_len_range = Uniform::new(<span class="number">0</span>, <span class="number">1000</span>);
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10_000 </span>{
orig_data.clear();
encoded_data.clear();
encoded_data_original_state.clear();
decoded.clear();
<span class="kw">let </span>input_len = input_len_range.sample(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">for _ in </span><span class="number">0</span>..input_len {
orig_data.push(rng.gen());
}
<span class="comment">// plenty of existing garbage in the encoded buffer
</span><span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10 </span>* input_len {
encoded_data.push(rng.gen());
}
encoded_data_original_state.extend_from_slice(<span class="kw-2">&amp;</span>encoded_data);
<span class="kw">let </span>config = random_config(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">let </span>encoded_size = encoded_size(input_len, config).unwrap();
<span class="macro">assert_eq!</span>(
encoded_size,
encode_config_slice(<span class="kw-2">&amp;</span>orig_data, config, <span class="kw-2">&amp;mut </span>encoded_data)
);
assert_encode_sanity(
std::str::from_utf8(<span class="kw-2">&amp;</span>encoded_data[<span class="number">0</span>..encoded_size]).unwrap(),
config,
input_len,
);
<span class="macro">assert_eq!</span>(
<span class="kw-2">&amp;</span>encoded_data[encoded_size..],
<span class="kw-2">&amp;</span>encoded_data_original_state[encoded_size..]
);
decode_config_buf(<span class="kw-2">&amp;</span>encoded_data[<span class="number">0</span>..encoded_size], config, <span class="kw-2">&amp;mut </span>decoded).unwrap();
<span class="macro">assert_eq!</span>(orig_data, decoded);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encode_config_slice_fits_into_precisely_sized_slice() {
<span class="kw">let </span><span class="kw-2">mut </span>orig_data = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>encoded_data = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>decoded = Vec::new();
<span class="kw">let </span>input_len_range = Uniform::new(<span class="number">0</span>, <span class="number">1000</span>);
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10_000 </span>{
orig_data.clear();
encoded_data.clear();
decoded.clear();
<span class="kw">let </span>input_len = input_len_range.sample(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">for _ in </span><span class="number">0</span>..input_len {
orig_data.push(rng.gen());
}
<span class="kw">let </span>config = random_config(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">let </span>encoded_size = encoded_size(input_len, config).unwrap();
encoded_data.resize(encoded_size, <span class="number">0</span>);
<span class="macro">assert_eq!</span>(
encoded_size,
encode_config_slice(<span class="kw-2">&amp;</span>orig_data, config, <span class="kw-2">&amp;mut </span>encoded_data)
);
assert_encode_sanity(
std::str::from_utf8(<span class="kw-2">&amp;</span>encoded_data[<span class="number">0</span>..encoded_size]).unwrap(),
config,
input_len,
);
decode_config_buf(<span class="kw-2">&amp;</span>encoded_data[<span class="number">0</span>..encoded_size], config, <span class="kw-2">&amp;mut </span>decoded).unwrap();
<span class="macro">assert_eq!</span>(orig_data, decoded);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encode_to_slice_random_valid_utf8() {
<span class="kw">let </span><span class="kw-2">mut </span>input = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>output = Vec::new();
<span class="kw">let </span>input_len_range = Uniform::new(<span class="number">0</span>, <span class="number">1000</span>);
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10_000 </span>{
input.clear();
output.clear();
<span class="kw">let </span>input_len = input_len_range.sample(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">for _ in </span><span class="number">0</span>..input_len {
input.push(rng.gen());
}
<span class="kw">let </span>config = random_config(<span class="kw-2">&amp;mut </span>rng);
<span class="comment">// fill up the output buffer with garbage
</span><span class="kw">let </span>encoded_size = encoded_size(input_len, config).unwrap();
<span class="kw">for _ in </span><span class="number">0</span>..encoded_size {
output.push(rng.gen());
}
<span class="kw">let </span>orig_output_buf = output.to_vec();
<span class="kw">let </span>bytes_written =
encode_to_slice(<span class="kw-2">&amp;</span>input, <span class="kw-2">&amp;mut </span>output, config.char_set.encode_table());
<span class="comment">// make sure the part beyond bytes_written is the same garbage it was before
</span><span class="macro">assert_eq!</span>(orig_output_buf[bytes_written..], output[bytes_written..]);
<span class="comment">// make sure the encoded bytes are UTF-8
</span><span class="kw">let _ </span>= str::from_utf8(<span class="kw-2">&amp;</span>output[<span class="number">0</span>..bytes_written]).unwrap();
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encode_with_padding_random_valid_utf8() {
<span class="kw">let </span><span class="kw-2">mut </span>input = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>output = Vec::new();
<span class="kw">let </span>input_len_range = Uniform::new(<span class="number">0</span>, <span class="number">1000</span>);
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10_000 </span>{
input.clear();
output.clear();
<span class="kw">let </span>input_len = input_len_range.sample(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">for _ in </span><span class="number">0</span>..input_len {
input.push(rng.gen());
}
<span class="kw">let </span>config = random_config(<span class="kw-2">&amp;mut </span>rng);
<span class="comment">// fill up the output buffer with garbage
</span><span class="kw">let </span>encoded_size = encoded_size(input_len, config).unwrap();
<span class="kw">for _ in </span><span class="number">0</span>..encoded_size + <span class="number">1000 </span>{
output.push(rng.gen());
}
<span class="kw">let </span>orig_output_buf = output.to_vec();
encode_with_padding(<span class="kw-2">&amp;</span>input, config, encoded_size, <span class="kw-2">&amp;mut </span>output[<span class="number">0</span>..encoded_size]);
<span class="comment">// make sure the part beyond b64 is the same garbage it was before
</span><span class="macro">assert_eq!</span>(orig_output_buf[encoded_size..], output[encoded_size..]);
<span class="comment">// make sure the encoded bytes are UTF-8
</span><span class="kw">let _ </span>= str::from_utf8(<span class="kw-2">&amp;</span>output[<span class="number">0</span>..encoded_size]).unwrap();
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>add_padding_random_valid_utf8() {
<span class="kw">let </span><span class="kw-2">mut </span>output = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="comment">// cover our bases for length % 3
</span><span class="kw">for </span>input_len <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{
output.clear();
<span class="comment">// fill output with random
</span><span class="kw">for _ in </span><span class="number">0</span>..<span class="number">10 </span>{
output.push(rng.gen());
}
<span class="kw">let </span>orig_output_buf = output.to_vec();
<span class="kw">let </span>bytes_written = add_padding(input_len, <span class="kw-2">&amp;mut </span>output);
<span class="comment">// make sure the part beyond bytes_written is the same garbage it was before
</span><span class="macro">assert_eq!</span>(orig_output_buf[bytes_written..], output[bytes_written..]);
<span class="comment">// make sure the encoded bytes are UTF-8
</span><span class="kw">let _ </span>= str::from_utf8(<span class="kw-2">&amp;</span>output[<span class="number">0</span>..bytes_written]).unwrap();
}
}
<span class="kw">fn </span>assert_encoded_length(input_len: usize, encoded_len: usize, config: Config) {
<span class="macro">assert_eq!</span>(encoded_len, encoded_size(input_len, config).unwrap());
<span class="kw">let </span><span class="kw-2">mut </span>bytes: Vec&lt;u8&gt; = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="kw">for _ in </span><span class="number">0</span>..input_len {
bytes.push(rng.gen());
}
<span class="kw">let </span>encoded = encode_config(<span class="kw-2">&amp;</span>bytes, config);
assert_encode_sanity(<span class="kw-2">&amp;</span>encoded, config, input_len);
<span class="macro">assert_eq!</span>(encoded_len, encoded.len());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>encode_imap() {
<span class="macro">assert_eq!</span>(
encode_config(<span class="string">b&quot;\xFB\xFF&quot;</span>, <span class="kw">crate</span>::IMAP_MUTF7),
encode_config(<span class="string">b&quot;\xFB\xFF&quot;</span>, <span class="kw">crate</span>::STANDARD_NO_PAD).replace(<span class="string">&quot;/&quot;</span>, <span class="string">&quot;,&quot;</span>)
);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="base64" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>