| <!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.21.2/src/decode.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>decode.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> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::engine::{general_purpose::STANDARD, DecodeEstimate, Engine}; |
| <span class="attribute">#[cfg(any(feature = <span class="string">"alloc"</span>, feature = <span class="string">"std"</span>, test))] |
| </span><span class="kw">use </span>alloc::vec::Vec; |
| <span class="kw">use </span>core::fmt; |
| <span class="attribute">#[cfg(any(feature = <span class="string">"std"</span>, test))] |
| </span><span class="kw">use </span>std::error; |
| |
| <span class="doccomment">/// Errors that can occur while decoding. |
| </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>DecodeError { |
| <span class="doccomment">/// An invalid byte was found in the input. The offset and offending byte are provided. |
| /// Padding characters (`=`) interspersed in the encoded form will be treated as invalid bytes. |
| </span>InvalidByte(usize, u8), |
| <span class="doccomment">/// The length of the input is invalid. |
| /// A typical cause of this is stray trailing whitespace or other separator bytes. |
| /// In the case where excess trailing bytes have produced an invalid length *and* the last byte |
| /// is also an invalid base64 symbol (as would be the case for whitespace, etc), `InvalidByte` |
| /// will be emitted instead of `InvalidLength` to make the issue easier to debug. |
| </span>InvalidLength, |
| <span class="doccomment">/// The last non-padding input symbol's encoded 6 bits have nonzero bits that will be discarded. |
| /// This is indicative of corrupted or truncated Base64. |
| /// Unlike `InvalidByte`, which reports symbols that aren't in the alphabet, this error is for |
| /// symbols that are in the alphabet but represent nonsensical encodings. |
| </span>InvalidLastSymbol(usize, u8), |
| <span class="doccomment">/// The nature of the padding was not as configured: absent or incorrect when it must be |
| /// canonical, or present when it must be absent, etc. |
| </span>InvalidPadding, |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>DecodeError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| <span class="self">Self</span>::InvalidByte(index, byte) => <span class="macro">write!</span>(f, <span class="string">"Invalid byte {}, offset {}."</span>, byte, index), |
| <span class="self">Self</span>::InvalidLength => <span class="macro">write!</span>(f, <span class="string">"Encoded text cannot have a 6-bit remainder."</span>), |
| <span class="self">Self</span>::InvalidLastSymbol(index, byte) => { |
| <span class="macro">write!</span>(f, <span class="string">"Invalid last symbol {}, offset {}."</span>, byte, index) |
| } |
| <span class="self">Self</span>::InvalidPadding => <span class="macro">write!</span>(f, <span class="string">"Invalid padding"</span>), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"std"</span>, test))] |
| </span><span class="kw">impl </span>error::Error <span class="kw">for </span>DecodeError { |
| <span class="kw">fn </span>cause(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="kw">dyn </span>error::Error> { |
| <span class="prelude-val">None |
| </span>} |
| } |
| |
| <span class="doccomment">/// Errors that can occur while decoding into a slice. |
| </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>DecodeSliceError { |
| <span class="doccomment">/// A [DecodeError] occurred |
| </span>DecodeError(DecodeError), |
| <span class="doccomment">/// The provided slice _may_ be too small. |
| /// |
| /// The check is conservative (assumes the last triplet of output bytes will all be needed). |
| </span>OutputSliceTooSmall, |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>DecodeSliceError { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <span class="kw">match </span><span class="self">self </span>{ |
| <span class="self">Self</span>::DecodeError(e) => <span class="macro">write!</span>(f, <span class="string">"DecodeError: {}"</span>, e), |
| <span class="self">Self</span>::OutputSliceTooSmall => <span class="macro">write!</span>(f, <span class="string">"Output slice too small"</span>), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(any(feature = <span class="string">"std"</span>, test))] |
| </span><span class="kw">impl </span>error::Error <span class="kw">for </span>DecodeSliceError { |
| <span class="kw">fn </span>cause(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="kw">dyn </span>error::Error> { |
| <span class="kw">match </span><span class="self">self </span>{ |
| DecodeSliceError::DecodeError(e) => <span class="prelude-val">Some</span>(e), |
| DecodeSliceError::OutputSliceTooSmall => <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<DecodeError> <span class="kw">for </span>DecodeSliceError { |
| <span class="kw">fn </span>from(e: DecodeError) -> <span class="self">Self </span>{ |
| DecodeSliceError::DecodeError(e) |
| } |
| } |
| |
| <span class="doccomment">/// Decode base64 using the [`STANDARD` engine](STANDARD). |
| /// |
| /// See [Engine::decode]. |
| </span><span class="attribute">#[deprecated(since = <span class="string">"0.21.0"</span>, note = <span class="string">"Use Engine::decode"</span>)] |
| #[cfg(any(feature = <span class="string">"alloc"</span>, feature = <span class="string">"std"</span>, test))] |
| </span><span class="kw">pub fn </span>decode<T: AsRef<[u8]>>(input: T) -> <span class="prelude-ty">Result</span><Vec<u8>, DecodeError> { |
| STANDARD.decode(input) |
| } |
| |
| <span class="doccomment">/// Decode from string reference as octets using the specified [Engine]. |
| /// |
| /// See [Engine::decode]. |
| ///Returns a `Result` containing a `Vec<u8>`. |
| </span><span class="attribute">#[deprecated(since = <span class="string">"0.21.0"</span>, note = <span class="string">"Use Engine::decode"</span>)] |
| #[cfg(any(feature = <span class="string">"alloc"</span>, feature = <span class="string">"std"</span>, test))] |
| </span><span class="kw">pub fn </span>decode_engine<E: Engine, T: AsRef<[u8]>>( |
| input: T, |
| engine: <span class="kw-2">&</span>E, |
| ) -> <span class="prelude-ty">Result</span><Vec<u8>, DecodeError> { |
| engine.decode(input) |
| } |
| |
| <span class="doccomment">/// Decode from string reference as octets. |
| /// |
| /// See [Engine::decode_vec]. |
| </span><span class="attribute">#[cfg(any(feature = <span class="string">"alloc"</span>, feature = <span class="string">"std"</span>, test))] |
| #[deprecated(since = <span class="string">"0.21.0"</span>, note = <span class="string">"Use Engine::decode_vec"</span>)] |
| </span><span class="kw">pub fn </span>decode_engine_vec<E: Engine, T: AsRef<[u8]>>( |
| input: T, |
| buffer: <span class="kw-2">&mut </span>Vec<u8>, |
| engine: <span class="kw-2">&</span>E, |
| ) -> <span class="prelude-ty">Result</span><(), DecodeError> { |
| engine.decode_vec(input, buffer) |
| } |
| |
| <span class="doccomment">/// Decode the input into the provided output slice. |
| /// |
| /// See [Engine::decode_slice]. |
| </span><span class="attribute">#[deprecated(since = <span class="string">"0.21.0"</span>, note = <span class="string">"Use Engine::decode_slice"</span>)] |
| </span><span class="kw">pub fn </span>decode_engine_slice<E: Engine, T: AsRef<[u8]>>( |
| input: T, |
| output: <span class="kw-2">&mut </span>[u8], |
| engine: <span class="kw-2">&</span>E, |
| ) -> <span class="prelude-ty">Result</span><usize, DecodeSliceError> { |
| engine.decode_slice(input, output) |
| } |
| |
| <span class="doccomment">/// Returns a conservative estimate of the decoded size of `encoded_len` base64 symbols (rounded up |
| /// to the next group of 3 decoded bytes). |
| /// |
| /// The resulting length will be a safe choice for the size of a decode buffer, but may have up to |
| /// 2 trailing bytes that won't end up being needed. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use base64::decoded_len_estimate; |
| /// |
| /// assert_eq!(3, decoded_len_estimate(1)); |
| /// assert_eq!(3, decoded_len_estimate(2)); |
| /// assert_eq!(3, decoded_len_estimate(3)); |
| /// assert_eq!(3, decoded_len_estimate(4)); |
| /// // start of the next quad of encoded symbols |
| /// assert_eq!(6, decoded_len_estimate(5)); |
| /// ``` |
| </span><span class="kw">pub fn </span>decoded_len_estimate(encoded_len: usize) -> usize { |
| STANDARD |
| .internal_decoded_len_estimate(encoded_len) |
| .decoded_len_estimate() |
| } |
| |
| <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>::{ |
| alphabet, |
| engine::{general_purpose, Config, GeneralPurpose}, |
| tests::{assert_encode_sanity, random_engine}, |
| }; |
| <span class="kw">use </span>rand::{ |
| distributions::{Distribution, Uniform}, |
| Rng, SeedableRng, |
| }; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>decode_into_nonempty_vec_doesnt_clobber_existing_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>encoded_data = String::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>decoded_with_prefix = Vec::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>decoded_without_prefix = Vec::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>prefix = 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(); |
| encoded_data.clear(); |
| decoded_with_prefix.clear(); |
| decoded_without_prefix.clear(); |
| prefix.clear(); |
| |
| <span class="kw">let </span>input_len = input_len_range.sample(<span class="kw-2">&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>engine = random_engine(<span class="kw-2">&mut </span>rng); |
| engine.encode_string(<span class="kw-2">&</span>orig_data, <span class="kw-2">&mut </span>encoded_data); |
| assert_encode_sanity(<span class="kw-2">&</span>encoded_data, engine.config().encode_padding(), input_len); |
| |
| <span class="kw">let </span>prefix_len = prefix_len_range.sample(<span class="kw-2">&mut </span>rng); |
| |
| <span class="comment">// fill the buf with a prefix |
| </span><span class="kw">for _ in </span><span class="number">0</span>..prefix_len { |
| prefix.push(rng.gen()); |
| } |
| |
| decoded_with_prefix.resize(prefix_len, <span class="number">0</span>); |
| decoded_with_prefix.copy_from_slice(<span class="kw-2">&</span>prefix); |
| |
| <span class="comment">// decode into the non-empty buf |
| </span>engine |
| .decode_vec(<span class="kw-2">&</span>encoded_data, <span class="kw-2">&mut </span>decoded_with_prefix) |
| .unwrap(); |
| <span class="comment">// also decode into the empty buf |
| </span>engine |
| .decode_vec(<span class="kw-2">&</span>encoded_data, <span class="kw-2">&mut </span>decoded_without_prefix) |
| .unwrap(); |
| |
| <span class="macro">assert_eq!</span>( |
| prefix_len + decoded_without_prefix.len(), |
| decoded_with_prefix.len() |
| ); |
| <span class="macro">assert_eq!</span>(orig_data, decoded_without_prefix); |
| |
| <span class="comment">// append plain decode onto prefix |
| </span>prefix.append(<span class="kw-2">&mut </span>decoded_without_prefix); |
| |
| <span class="macro">assert_eq!</span>(prefix, decoded_with_prefix); |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>decode_slice_doesnt_clobber_existing_prefix_or_suffix() { |
| do_decode_slice_doesnt_clobber_existing_prefix_or_suffix(|e, input, output| { |
| e.decode_slice(input, output).unwrap() |
| }) |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>decode_slice_unchecked_doesnt_clobber_existing_prefix_or_suffix() { |
| do_decode_slice_doesnt_clobber_existing_prefix_or_suffix(|e, input, output| { |
| e.decode_slice_unchecked(input, output).unwrap() |
| }) |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>decode_engine_estimation_works_for_various_lengths() { |
| <span class="kw">let </span>engine = GeneralPurpose::new(<span class="kw-2">&</span>alphabet::STANDARD, general_purpose::NO_PAD); |
| <span class="kw">for </span>num_prefix_quads <span class="kw">in </span><span class="number">0</span>..<span class="number">100 </span>{ |
| <span class="kw">for </span>suffix <span class="kw">in </span><span class="kw-2">&</span>[<span class="string">"AA"</span>, <span class="string">"AAA"</span>, <span class="string">"AAAA"</span>] { |
| <span class="kw">let </span><span class="kw-2">mut </span>prefix = <span class="string">"AAAA"</span>.repeat(num_prefix_quads); |
| prefix.push_str(suffix); |
| <span class="comment">// make sure no overflow (and thus a panic) occurs |
| </span><span class="kw">let </span>res = engine.decode(prefix); |
| <span class="macro">assert!</span>(res.is_ok()); |
| } |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>decode_slice_output_length_errors() { |
| <span class="kw">for </span>num_quads <span class="kw">in </span><span class="number">1</span>..<span class="number">100 </span>{ |
| <span class="kw">let </span>input = <span class="string">"AAAA"</span>.repeat(num_quads); |
| <span class="kw">let </span><span class="kw-2">mut </span>vec = <span class="macro">vec!</span>[<span class="number">0</span>; (num_quads - <span class="number">1</span>) * <span class="number">3</span>]; |
| <span class="macro">assert_eq!</span>( |
| DecodeSliceError::OutputSliceTooSmall, |
| STANDARD.decode_slice(<span class="kw-2">&</span>input, <span class="kw-2">&mut </span>vec).unwrap_err() |
| ); |
| vec.push(<span class="number">0</span>); |
| <span class="macro">assert_eq!</span>( |
| DecodeSliceError::OutputSliceTooSmall, |
| STANDARD.decode_slice(<span class="kw-2">&</span>input, <span class="kw-2">&mut </span>vec).unwrap_err() |
| ); |
| vec.push(<span class="number">0</span>); |
| <span class="macro">assert_eq!</span>( |
| DecodeSliceError::OutputSliceTooSmall, |
| STANDARD.decode_slice(<span class="kw-2">&</span>input, <span class="kw-2">&mut </span>vec).unwrap_err() |
| ); |
| vec.push(<span class="number">0</span>); |
| <span class="comment">// now it works |
| </span><span class="macro">assert_eq!</span>( |
| num_quads * <span class="number">3</span>, |
| STANDARD.decode_slice(<span class="kw-2">&</span>input, <span class="kw-2">&mut </span>vec).unwrap() |
| ); |
| } |
| } |
| |
| <span class="kw">fn </span>do_decode_slice_doesnt_clobber_existing_prefix_or_suffix< |
| F: Fn(<span class="kw-2">&</span>GeneralPurpose, <span class="kw-2">&</span>[u8], <span class="kw-2">&mut </span>[u8]) -> usize, |
| >( |
| call_decode: F, |
| ) { |
| <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 = String::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>decode_buf = Vec::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>decode_buf_copy: Vec<u8> = 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(); |
| decode_buf.clear(); |
| decode_buf_copy.clear(); |
| |
| <span class="kw">let </span>input_len = input_len_range.sample(<span class="kw-2">&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>engine = random_engine(<span class="kw-2">&mut </span>rng); |
| engine.encode_string(<span class="kw-2">&</span>orig_data, <span class="kw-2">&mut </span>encoded_data); |
| assert_encode_sanity(<span class="kw-2">&</span>encoded_data, engine.config().encode_padding(), input_len); |
| |
| <span class="comment">// fill the buffer with random garbage, long enough to have some room before and after |
| </span><span class="kw">for _ in </span><span class="number">0</span>..<span class="number">5000 </span>{ |
| decode_buf.push(rng.gen()); |
| } |
| |
| <span class="comment">// keep a copy for later comparison |
| </span>decode_buf_copy.extend(decode_buf.iter()); |
| |
| <span class="kw">let </span>offset = <span class="number">1000</span>; |
| |
| <span class="comment">// decode into the non-empty buf |
| </span><span class="kw">let </span>decode_bytes_written = |
| call_decode(<span class="kw-2">&</span>engine, encoded_data.as_bytes(), <span class="kw-2">&mut </span>decode_buf[offset..]); |
| |
| <span class="macro">assert_eq!</span>(orig_data.len(), decode_bytes_written); |
| <span class="macro">assert_eq!</span>( |
| orig_data, |
| <span class="kw-2">&</span>decode_buf[offset..(offset + decode_bytes_written)] |
| ); |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&</span>decode_buf_copy[<span class="number">0</span>..offset], <span class="kw-2">&</span>decode_buf[<span class="number">0</span>..offset]); |
| <span class="macro">assert_eq!</span>( |
| <span class="kw-2">&</span>decode_buf_copy[offset + decode_bytes_written..], |
| <span class="kw-2">&</span>decode_buf[offset + decode_bytes_written..] |
| ); |
| } |
| } |
| } |
| </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> |
