blob: 966c0d1d5debc0efb4566fabdc8a04e0f2a87600 [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/chunked_encoder.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>chunked_encoder.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>
</pre><pre class="rust"><code><span class="kw">use crate</span>::{
encode::{add_padding, encode_to_slice},
Config,
};
<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;
<span class="kw">use </span>core::cmp;
<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>core::str;
<span class="doccomment">/// The output mechanism for ChunkedEncoder&#39;s encoded bytes.
</span><span class="kw">pub trait </span>Sink {
<span class="kw">type </span>Error;
<span class="doccomment">/// Handle a chunk of encoded base64 data (as UTF-8 bytes)
</span><span class="kw">fn </span>write_encoded_bytes(<span class="kw-2">&amp;mut </span><span class="self">self</span>, encoded: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Error&gt;;
}
<span class="kw">const </span>BUF_SIZE: usize = <span class="number">1024</span>;
<span class="doccomment">/// A base64 encoder that emits encoded bytes in chunks without heap allocation.
</span><span class="kw">pub struct </span>ChunkedEncoder {
config: Config,
max_input_chunk_len: usize,
}
<span class="kw">impl </span>ChunkedEncoder {
<span class="kw">pub fn </span>new(config: Config) -&gt; ChunkedEncoder {
ChunkedEncoder {
config,
max_input_chunk_len: max_input_length(BUF_SIZE, config),
}
}
<span class="kw">pub fn </span>encode&lt;S: Sink&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, bytes: <span class="kw-2">&amp;</span>[u8], sink: <span class="kw-2">&amp;mut </span>S) -&gt; <span class="prelude-ty">Result</span>&lt;(), S::Error&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>encode_buf: [u8; BUF_SIZE] = [<span class="number">0</span>; BUF_SIZE];
<span class="kw">let </span>encode_table = <span class="self">self</span>.config.char_set.encode_table();
<span class="kw">let </span><span class="kw-2">mut </span>input_index = <span class="number">0</span>;
<span class="kw">while </span>input_index &lt; bytes.len() {
<span class="comment">// either the full input chunk size, or it&#39;s the last iteration
</span><span class="kw">let </span>input_chunk_len = cmp::min(<span class="self">self</span>.max_input_chunk_len, bytes.len() - input_index);
<span class="kw">let </span>chunk = <span class="kw-2">&amp;</span>bytes[input_index..(input_index + input_chunk_len)];
<span class="kw">let </span><span class="kw-2">mut </span>b64_bytes_written = encode_to_slice(chunk, <span class="kw-2">&amp;mut </span>encode_buf, encode_table);
input_index += input_chunk_len;
<span class="kw">let </span>more_input_left = input_index &lt; bytes.len();
<span class="kw">if </span><span class="self">self</span>.config.pad &amp;&amp; !more_input_left {
<span class="comment">// no more input, add padding if needed. Buffer will have room because
// max_input_length leaves room for it.
</span>b64_bytes_written += add_padding(bytes.len(), <span class="kw-2">&amp;mut </span>encode_buf[b64_bytes_written..]);
}
sink.write_encoded_bytes(<span class="kw-2">&amp;</span>encode_buf[<span class="number">0</span>..b64_bytes_written])<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="doccomment">/// Calculate the longest input that can be encoded for the given output buffer size.
///
/// If the config requires padding, two bytes of buffer space will be set aside so that the last
/// chunk of input can be encoded safely.
///
/// The input length will always be a multiple of 3 so that no encoding state has to be carried over
/// between chunks.
</span><span class="kw">fn </span>max_input_length(encoded_buf_len: usize, config: Config) -&gt; usize {
<span class="kw">let </span>effective_buf_len = <span class="kw">if </span>config.pad {
<span class="comment">// make room for padding
</span>encoded_buf_len
.checked_sub(<span class="number">2</span>)
.expect(<span class="string">&quot;Don&#39;t use a tiny buffer&quot;</span>)
} <span class="kw">else </span>{
encoded_buf_len
};
<span class="comment">// No padding, so just normal base64 expansion.
</span>(effective_buf_len / <span class="number">4</span>) * <span class="number">3
</span>}
<span class="comment">// A really simple sink that just appends to a string
</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</span>(<span class="kw">crate</span>) <span class="kw">struct </span>StringSink&lt;<span class="lifetime">&#39;a</span>&gt; {
string: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>String,
}
<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">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; StringSink&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(s: <span class="kw-2">&amp;mut </span>String) -&gt; StringSink {
StringSink { string: s }
}
}
<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">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Sink <span class="kw">for </span>StringSink&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">type </span>Error = ();
<span class="kw">fn </span>write_encoded_bytes(<span class="kw-2">&amp;mut </span><span class="self">self</span>, s: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), <span class="self">Self</span>::Error&gt; {
<span class="self">self</span>.string.push_str(str::from_utf8(s).unwrap());
<span class="prelude-val">Ok</span>(())
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">pub mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use crate</span>::{encode_config_buf, tests::random_config, CharacterSet, STANDARD};
<span class="kw">use </span>rand::{
distributions::{Distribution, Uniform},
FromEntropy, Rng,
};
<span class="attribute">#[test]
</span><span class="kw">fn </span>chunked_encode_empty() {
<span class="macro">assert_eq!</span>(<span class="string">&quot;&quot;</span>, chunked_encode_str(<span class="kw-2">&amp;</span>[], STANDARD));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>chunked_encode_intermediate_fast_loop() {
<span class="comment">// &gt; 8 bytes input, will enter the pretty fast loop
</span><span class="macro">assert_eq!</span>(
<span class="string">&quot;Zm9vYmFyYmF6cXV4&quot;</span>,
chunked_encode_str(<span class="string">b&quot;foobarbazqux&quot;</span>, STANDARD)
);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>chunked_encode_fast_loop() {
<span class="comment">// &gt; 32 bytes input, will enter the uber fast loop
</span><span class="macro">assert_eq!</span>(
<span class="string">&quot;Zm9vYmFyYmF6cXV4cXV1eGNvcmdlZ3JhdWx0Z2FycGx5eg==&quot;</span>,
chunked_encode_str(<span class="string">b&quot;foobarbazquxquuxcorgegraultgarplyz&quot;</span>, STANDARD)
);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>chunked_encode_slow_loop_only() {
<span class="comment">// &lt; 8 bytes input, slow loop only
</span><span class="macro">assert_eq!</span>(<span class="string">&quot;Zm9vYmFy&quot;</span>, chunked_encode_str(<span class="string">b&quot;foobar&quot;</span>, STANDARD));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>chunked_encode_matches_normal_encode_random_string_sink() {
<span class="kw">let </span>helper = StringSinkTestHelper;
chunked_encode_matches_normal_encode_random(<span class="kw-2">&amp;</span>helper);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>max_input_length_no_pad() {
<span class="kw">let </span>config = config_with_pad(<span class="bool-val">false</span>);
<span class="macro">assert_eq!</span>(<span class="number">768</span>, max_input_length(<span class="number">1024</span>, config));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>max_input_length_with_pad_decrements_one_triple() {
<span class="kw">let </span>config = config_with_pad(<span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(<span class="number">765</span>, max_input_length(<span class="number">1024</span>, config));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>max_input_length_with_pad_one_byte_short() {
<span class="kw">let </span>config = config_with_pad(<span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(<span class="number">765</span>, max_input_length(<span class="number">1025</span>, config));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>max_input_length_with_pad_fits_exactly() {
<span class="kw">let </span>config = config_with_pad(<span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(<span class="number">768</span>, max_input_length(<span class="number">1026</span>, config));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>max_input_length_cant_use_extra_single_encoded_byte() {
<span class="kw">let </span>config = Config::new(<span class="kw">crate</span>::CharacterSet::Standard, <span class="bool-val">false</span>);
<span class="macro">assert_eq!</span>(<span class="number">300</span>, max_input_length(<span class="number">401</span>, config));
}
<span class="kw">pub fn </span>chunked_encode_matches_normal_encode_random&lt;S: SinkTestHelper&gt;(sink_test_helper: <span class="kw-2">&amp;</span>S) {
<span class="kw">let </span><span class="kw-2">mut </span>input_buf: Vec&lt;u8&gt; = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>output_buf = String::new();
<span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rngs::SmallRng::from_entropy();
<span class="kw">let </span>input_len_range = Uniform::new(<span class="number">1</span>, <span class="number">10_000</span>);
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">5_000 </span>{
input_buf.clear();
output_buf.clear();
<span class="kw">let </span>buf_len = input_len_range.sample(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">for _ in </span><span class="number">0</span>..buf_len {
input_buf.push(rng.gen());
}
<span class="kw">let </span>config = random_config(<span class="kw-2">&amp;mut </span>rng);
<span class="kw">let </span>chunk_encoded_string = sink_test_helper.encode_to_string(config, <span class="kw-2">&amp;</span>input_buf);
encode_config_buf(<span class="kw-2">&amp;</span>input_buf, config, <span class="kw-2">&amp;mut </span>output_buf);
<span class="macro">assert_eq!</span>(
output_buf, chunk_encoded_string,
<span class="string">&quot;input len={}, config: pad={}&quot;</span>,
buf_len, config.pad
);
}
}
<span class="kw">fn </span>chunked_encode_str(bytes: <span class="kw-2">&amp;</span>[u8], config: Config) -&gt; String {
<span class="kw">let </span><span class="kw-2">mut </span>s = String::new();
{
<span class="kw">let </span><span class="kw-2">mut </span>sink = StringSink::new(<span class="kw-2">&amp;mut </span>s);
<span class="kw">let </span>encoder = ChunkedEncoder::new(config);
encoder.encode(bytes, <span class="kw-2">&amp;mut </span>sink).unwrap();
}
<span class="kw">return </span>s;
}
<span class="kw">fn </span>config_with_pad(pad: bool) -&gt; Config {
Config::new(CharacterSet::Standard, pad)
}
<span class="comment">// An abstraction around sinks so that we can have tests that easily to any sink implementation
</span><span class="kw">pub trait </span>SinkTestHelper {
<span class="kw">fn </span>encode_to_string(<span class="kw-2">&amp;</span><span class="self">self</span>, config: Config, bytes: <span class="kw-2">&amp;</span>[u8]) -&gt; String;
}
<span class="kw">struct </span>StringSinkTestHelper;
<span class="kw">impl </span>SinkTestHelper <span class="kw">for </span>StringSinkTestHelper {
<span class="kw">fn </span>encode_to_string(<span class="kw-2">&amp;</span><span class="self">self</span>, config: Config, bytes: <span class="kw-2">&amp;</span>[u8]) -&gt; String {
<span class="kw">let </span>encoder = ChunkedEncoder::new(config);
<span class="kw">let </span><span class="kw-2">mut </span>s = String::new();
{
<span class="kw">let </span><span class="kw-2">mut </span>sink = StringSink::new(<span class="kw-2">&amp;mut </span>s);
encoder.encode(bytes, <span class="kw-2">&amp;mut </span>sink).unwrap();
}
s
}
}
}
</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>