api-docs/crates-enclave/src/miniz_oxide/inflate/mod.rs.html - incubator-teaclave-website - Git at Google

 <!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/miniz_oxide-0.7.1/src/inflate/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="../../../miniz_oxide/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="../../../miniz_oxide/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>
 </pre><pre class="rust"><code><span class="doccomment">//! This module contains functionality for decompression.

 </span><span class="attribute">#[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">use </span><span class="kw">crate</span>::alloc::{boxed::Box, vec, vec::Vec};
 <span class="kw">use </span>::core::usize;
 <span class="attribute">#[cfg(all(feature = <span class="string">&quot;std&quot;</span>, feature = <span class="string">&quot;with-alloc&quot;</span>))]
 </span><span class="kw">use </span>std::error::Error;

 <span class="kw">pub mod </span>core;
 <span class="kw">mod </span>output_buffer;
 <span class="kw">pub mod </span>stream;
 <span class="kw">use </span><span class="self">self</span>::core::<span class="kw-2">*</span>;

 <span class="kw">const </span>TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS: i32 = -<span class="number">4</span>;
 <span class="kw">const </span>TINFL_STATUS_BAD_PARAM: i32 = -<span class="number">3</span>;
 <span class="kw">const </span>TINFL_STATUS_ADLER32_MISMATCH: i32 = -<span class="number">2</span>;
 <span class="kw">const </span>TINFL_STATUS_FAILED: i32 = -<span class="number">1</span>;
 <span class="kw">const </span>TINFL_STATUS_DONE: i32 = <span class="number">0</span>;
 <span class="kw">const </span>TINFL_STATUS_NEEDS_MORE_INPUT: i32 = <span class="number">1</span>;
 <span class="kw">const </span>TINFL_STATUS_HAS_MORE_OUTPUT: i32 = <span class="number">2</span>;

 <span class="doccomment">/// Return status codes.
 </span><span class="attribute">#[repr(i8)]
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 </span><span class="kw">pub enum </span>TINFLStatus {
     <span class="doccomment">/// More input data was expected, but the caller indicated that there was no more data, so the
     /// input stream is likely truncated.
     ///
     /// This can&#39;t happen if you have provided the
     /// [`TINFL_FLAG_HAS_MORE_INPUT`][core::inflate_flags::TINFL_FLAG_HAS_MORE_INPUT] flag to the
     /// decompression.  By setting that flag, you indicate more input exists but is not provided,
     /// and so reaching the end of the input data without finding the end of the compressed stream
     /// would instead return a [`NeedsMoreInput`][Self::NeedsMoreInput] status.
     </span>FailedCannotMakeProgress = TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS <span class="kw">as </span>i8,

     <span class="doccomment">/// The output buffer is an invalid size; consider the `flags` parameter.
     </span>BadParam = TINFL_STATUS_BAD_PARAM <span class="kw">as </span>i8,

     <span class="doccomment">/// The decompression went fine, but the adler32 checksum did not match the one
     /// provided in the header.
     </span>Adler32Mismatch = TINFL_STATUS_ADLER32_MISMATCH <span class="kw">as </span>i8,

     <span class="doccomment">/// Failed to decompress due to invalid data.
     </span>Failed = TINFL_STATUS_FAILED <span class="kw">as </span>i8,

     <span class="doccomment">/// Finished decompression without issues.
     ///
     /// This indicates the end of the compressed stream has been reached.
     </span>Done = TINFL_STATUS_DONE <span class="kw">as </span>i8,

     <span class="doccomment">/// The decompressor needs more input data to continue decompressing.
     ///
     /// This occurs when there&#39;s no more consumable input, but the end of the stream hasn&#39;t been
     /// reached, and you have supplied the
     /// [`TINFL_FLAG_HAS_MORE_INPUT`][core::inflate_flags::TINFL_FLAG_HAS_MORE_INPUT] flag to the
     /// decompressor.  Had you not supplied that flag (which would mean you were asserting that you
     /// believed all the data was available) you would have gotten a
     /// [`FailedCannotMakeProcess`][Self::FailedCannotMakeProgress] instead.
     </span>NeedsMoreInput = TINFL_STATUS_NEEDS_MORE_INPUT <span class="kw">as </span>i8,

     <span class="doccomment">/// There is still pending data that didn&#39;t fit in the output buffer.
     </span>HasMoreOutput = TINFL_STATUS_HAS_MORE_OUTPUT <span class="kw">as </span>i8,
 }

 <span class="kw">impl </span>TINFLStatus {
     <span class="kw">pub fn </span>from_i32(value: i32) -&gt; <span class="prelude-ty">Option</span>&lt;TINFLStatus&gt; {
         <span class="kw">use </span><span class="self">self</span>::TINFLStatus::<span class="kw-2">*</span>;
         <span class="kw">match </span>value {
             TINFL_STATUS_FAILED_CANNOT_MAKE_PROGRESS =&gt; <span class="prelude-val">Some</span>(FailedCannotMakeProgress),
             TINFL_STATUS_BAD_PARAM =&gt; <span class="prelude-val">Some</span>(BadParam),
             TINFL_STATUS_ADLER32_MISMATCH =&gt; <span class="prelude-val">Some</span>(Adler32Mismatch),
             TINFL_STATUS_FAILED =&gt; <span class="prelude-val">Some</span>(Failed),
             TINFL_STATUS_DONE =&gt; <span class="prelude-val">Some</span>(Done),
             TINFL_STATUS_NEEDS_MORE_INPUT =&gt; <span class="prelude-val">Some</span>(NeedsMoreInput),
             TINFL_STATUS_HAS_MORE_OUTPUT =&gt; <span class="prelude-val">Some</span>(HasMoreOutput),
             <span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
         }
     }
 }

 <span class="doccomment">/// Struct return when decompress_to_vec functions fail.
 </span><span class="attribute">#[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 #[derive(Debug)]
 </span><span class="kw">pub struct </span>DecompressError {
     <span class="doccomment">/// Decompressor status on failure. See [TINFLStatus] for details.
     </span><span class="kw">pub </span>status: TINFLStatus,
     <span class="doccomment">/// The currently decompressed data if any.
     </span><span class="kw">pub </span>output: Vec&lt;u8&gt;,
 }

 <span class="attribute">#[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">impl </span>alloc::fmt::Display <span class="kw">for </span>DecompressError {
     <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>::core::fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; ::core::fmt::Result {
         f.write_str(<span class="kw">match </span><span class="self">self</span>.status {
             TINFLStatus::FailedCannotMakeProgress =&gt; <span class="string">&quot;Truncated input stream&quot;</span>,
             TINFLStatus::BadParam =&gt; <span class="string">&quot;Invalid output buffer size&quot;</span>,
             TINFLStatus::Adler32Mismatch =&gt; <span class="string">&quot;Adler32 checksum mismatch&quot;</span>,
             TINFLStatus::Failed =&gt; <span class="string">&quot;Invalid input data&quot;</span>,
             TINFLStatus::Done =&gt; <span class="macro">unreachable!</span>(),
             TINFLStatus::NeedsMoreInput =&gt; <span class="string">&quot;Truncated input stream&quot;</span>,
             TINFLStatus::HasMoreOutput =&gt; <span class="string">&quot;Output size exceeded the specified limit&quot;</span>,
         })
     }
 }

 <span class="doccomment">/// Implement Error trait only if std feature is requested as it requires std.
 </span><span class="attribute">#[cfg(all(feature = <span class="string">&quot;std&quot;</span>, feature = <span class="string">&quot;with-alloc&quot;</span>))]
 </span><span class="kw">impl </span>Error <span class="kw">for </span>DecompressError {}

 <span class="attribute">#[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">fn </span>decompress_error(status: TINFLStatus, output: Vec&lt;u8&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, DecompressError&gt; {
     <span class="prelude-val">Err</span>(DecompressError { status, output })
 }

 <span class="doccomment">/// Decompress the deflate-encoded data in `input` to a vector.
 ///
 /// NOTE: This function will not bound the output, so if the output is large enough it can result in an out of memory error.
 /// It is therefore suggested to not use this for anything other than test programs, use the functions with a specified limit, or
 /// ideally streaming decompression via the [flate2](https://github.com/alexcrichton/flate2-rs) library instead.
 ///
 /// Returns a [`Result`] containing the [`Vec`] of decompressed data on success, and a [struct][DecompressError] containing the status and so far decompressed data if any on failure.
 </span><span class="attribute">#[inline]
 #[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">pub fn </span>decompress_to_vec(input: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, DecompressError&gt; {
     decompress_to_vec_inner(input, <span class="number">0</span>, usize::max_value())
 }

 <span class="doccomment">/// Decompress the deflate-encoded data (with a zlib wrapper) in `input` to a vector.
 ///
 /// NOTE: This function will not bound the output, so if the output is large enough it can result in an out of memory error.
 /// It is therefore suggested to not use this for anything other than test programs, use the functions with a specified limit, or
 /// ideally streaming decompression via the [flate2](https://github.com/alexcrichton/flate2-rs) library instead.
 ///
 /// Returns a [`Result`] containing the [`Vec`] of decompressed data on success, and a [struct][DecompressError] containing the status and so far decompressed data if any on failure.
 </span><span class="attribute">#[inline]
 #[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">pub fn </span>decompress_to_vec_zlib(input: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, DecompressError&gt; {
     decompress_to_vec_inner(
         input,
         inflate_flags::TINFL_FLAG_PARSE_ZLIB_HEADER,
         usize::max_value(),
     )
 }

 <span class="doccomment">/// Decompress the deflate-encoded data in `input` to a vector.
 ///
 /// The vector is grown to at most `max_size` bytes; if the data does not fit in that size,
 /// the error [struct][DecompressError] will contain the status [`TINFLStatus::HasMoreOutput`] and the data that was decompressed on failure.
 ///
 /// As this function tries to decompress everything in one go, it&#39;s not ideal for general use outside of tests or where the output size is expected to be small.
 /// It is suggested to use streaming decompression via the [flate2](https://github.com/alexcrichton/flate2-rs) library instead.
 ///
 /// Returns a [`Result`] containing the [`Vec`] of decompressed data on success, and a [struct][DecompressError] on failure.
 </span><span class="attribute">#[inline]
 #[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">pub fn </span>decompress_to_vec_with_limit(
     input: <span class="kw-2">&amp;</span>[u8],
     max_size: usize,
 ) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, DecompressError&gt; {
     decompress_to_vec_inner(input, <span class="number">0</span>, max_size)
 }

 <span class="doccomment">/// Decompress the deflate-encoded data (with a zlib wrapper) in `input` to a vector.
 /// The vector is grown to at most `max_size` bytes; if the data does not fit in that size,
 /// the error [struct][DecompressError] will contain the status [`TINFLStatus::HasMoreOutput`] and the data that was decompressed on failure.
 ///
 /// As this function tries to decompress everything in one go, it&#39;s not ideal for general use outside of tests or where the output size is expected to be small.
 /// It is suggested to use streaming decompression via the [flate2](https://github.com/alexcrichton/flate2-rs) library instead.
 ///
 /// Returns a [`Result`] containing the [`Vec`] of decompressed data on success, and a [struct][DecompressError] on failure.
 </span><span class="attribute">#[inline]
 #[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">pub fn </span>decompress_to_vec_zlib_with_limit(
     input: <span class="kw-2">&amp;</span>[u8],
     max_size: usize,
 ) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, DecompressError&gt; {
     decompress_to_vec_inner(input, inflate_flags::TINFL_FLAG_PARSE_ZLIB_HEADER, max_size)
 }

 <span class="doccomment">/// Backend of various to-[`Vec`] decompressions.
 ///
 /// Returns [`Vec`] of decompressed data on success and the [error struct][DecompressError] with details on failure.
 </span><span class="attribute">#[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
 </span><span class="kw">fn </span>decompress_to_vec_inner(
     input: <span class="kw-2">&amp;</span>[u8],
     flags: u32,
     max_output_size: usize,
 ) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, DecompressError&gt; {
     <span class="kw">let </span>flags = flags | inflate_flags::TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF;
     <span class="kw">let </span><span class="kw-2">mut </span>ret: Vec&lt;u8&gt; = <span class="macro">vec!</span>[<span class="number">0</span>; input.len().saturating_mul(<span class="number">2</span>).min(max_output_size)];

     <span class="kw">let </span><span class="kw-2">mut </span>decomp = Box::&lt;DecompressorOxide&gt;::default();

     <span class="kw">let </span><span class="kw-2">mut </span>in_pos = <span class="number">0</span>;
     <span class="kw">let </span><span class="kw-2">mut </span>out_pos = <span class="number">0</span>;
     <span class="kw">loop </span>{
         <span class="comment">// Wrap the whole output slice so we know we have enough of the
         // decompressed data for matches.
         </span><span class="kw">let </span>(status, in_consumed, out_consumed) =
             decompress(<span class="kw-2">&amp;mut </span>decomp, <span class="kw-2">&amp;</span>input[in_pos..], <span class="kw-2">&amp;mut </span>ret, out_pos, flags);
         in_pos += in_consumed;
         out_pos += out_consumed;

         <span class="kw">match </span>status {
             TINFLStatus::Done =&gt; {
                 ret.truncate(out_pos);
                 <span class="kw">return </span><span class="prelude-val">Ok</span>(ret);
             }

             TINFLStatus::HasMoreOutput =&gt; {
                 <span class="comment">// if the buffer has already reached the size limit, return an error
                 </span><span class="kw">if </span>ret.len() &gt;= max_output_size {
                     <span class="kw">return </span>decompress_error(TINFLStatus::HasMoreOutput, ret);
                 }
                 <span class="comment">// calculate the new length, capped at `max_output_size`
                 </span><span class="kw">let </span>new_len = ret.len().saturating_mul(<span class="number">2</span>).min(max_output_size);
                 ret.resize(new_len, <span class="number">0</span>);
             }

             <span class="kw">_ </span>=&gt; <span class="kw">return </span>decompress_error(status, ret),
         }
     }
 }

 <span class="doccomment">/// Decompress one or more source slices from an iterator into the output slice.
 ///
 /// * On success, returns the number of bytes that were written.
 /// * On failure, returns the failure status code.
 ///
 /// This will fail if the output buffer is not large enough, but in that case
 /// the output buffer will still contain the partial decompression.
 ///
 /// * `out` the output buffer.
 /// * `it` the iterator of input slices.
 /// * `zlib_header` if the first slice out of the iterator is expected to have a
 ///   Zlib header. Otherwise the slices are assumed to be the deflate data only.
 /// * `ignore_adler32` if the adler32 checksum should be calculated or not.
 </span><span class="kw">pub fn </span>decompress_slice_iter_to_slice&lt;<span class="lifetime">&#39;out</span>, <span class="lifetime">&#39;inp</span>&gt;(
     out: <span class="kw-2">&amp;</span><span class="lifetime">&#39;out </span><span class="kw-2">mut </span>[u8],
     it: <span class="kw">impl </span>Iterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;inp </span>[u8]&gt;,
     zlib_header: bool,
     ignore_adler32: bool,
 ) -&gt; <span class="prelude-ty">Result</span>&lt;usize, TINFLStatus&gt; {
     <span class="kw">use </span><span class="self">self</span>::core::inflate_flags::<span class="kw-2">*</span>;

     <span class="kw">let </span><span class="kw-2">mut </span>it = it.peekable();
     <span class="kw">let </span>r = <span class="kw-2">&amp;mut </span>DecompressorOxide::new();
     <span class="kw">let </span><span class="kw-2">mut </span>out_pos = <span class="number">0</span>;
     <span class="kw">while let </span><span class="prelude-val">Some</span>(in_buf) = it.next() {
         <span class="kw">let </span>has_more = it.peek().is_some();
         <span class="kw">let </span>flags = {
             <span class="kw">let </span><span class="kw-2">mut </span>f = TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF;
             <span class="kw">if </span>zlib_header {
                 f |= TINFL_FLAG_PARSE_ZLIB_HEADER;
             }
             <span class="kw">if </span>ignore_adler32 {
                 f |= TINFL_FLAG_IGNORE_ADLER32;
             }
             <span class="kw">if </span>has_more {
                 f |= TINFL_FLAG_HAS_MORE_INPUT;
             }
             f
         };
         <span class="kw">let </span>(status, _input_read, bytes_written) = decompress(r, in_buf, out, out_pos, flags);
         out_pos += bytes_written;
         <span class="kw">match </span>status {
             TINFLStatus::NeedsMoreInput =&gt; <span class="kw">continue</span>,
             TINFLStatus::Done =&gt; <span class="kw">return </span><span class="prelude-val">Ok</span>(out_pos),
             e =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(e),
         }
     }
     <span class="comment">// If we ran out of source slices without getting a `Done` from the
     // decompression we can call it a failure.
     </span><span class="prelude-val">Err</span>(TINFLStatus::FailedCannotMakeProgress)
 }

 <span class="attribute">#[cfg(test)]
 </span><span class="kw">mod </span>test {
     <span class="kw">use super</span>::{
         decompress_slice_iter_to_slice, decompress_to_vec_zlib, decompress_to_vec_zlib_with_limit,
         DecompressError, TINFLStatus,
     };
     <span class="kw">const </span>ENCODED: [u8; <span class="number">20</span>] = [
         <span class="number">120</span>, <span class="number">156</span>, <span class="number">243</span>, <span class="number">72</span>, <span class="number">205</span>, <span class="number">201</span>, <span class="number">201</span>, <span class="number">215</span>, <span class="number">81</span>, <span class="number">168</span>, <span class="number">202</span>, <span class="number">201</span>, <span class="number">76</span>, <span class="number">82</span>, <span class="number">4</span>, <span class="number">0</span>, <span class="number">27</span>, <span class="number">101</span>, <span class="number">4</span>, <span class="number">19</span>,
     ];

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>decompress_vec() {
         <span class="kw">let </span>res = decompress_to_vec_zlib(<span class="kw-2">&amp;</span>ENCODED[..]).unwrap();
         <span class="macro">assert_eq!</span>(res.as_slice(), <span class="kw-2">&amp;</span><span class="string">b&quot;Hello, zlib!&quot;</span>[..]);
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>decompress_vec_with_high_limit() {
         <span class="kw">let </span>res = decompress_to_vec_zlib_with_limit(<span class="kw-2">&amp;</span>ENCODED[..], <span class="number">100_000</span>).unwrap();
         <span class="macro">assert_eq!</span>(res.as_slice(), <span class="kw-2">&amp;</span><span class="string">b&quot;Hello, zlib!&quot;</span>[..]);
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>fail_to_decompress_with_limit() {
         <span class="kw">let </span>res = decompress_to_vec_zlib_with_limit(<span class="kw-2">&amp;</span>ENCODED[..], <span class="number">8</span>);
         <span class="kw">match </span>res {
             <span class="prelude-val">Err</span>(DecompressError {
                 status: TINFLStatus::HasMoreOutput,
                 ..
             }) =&gt; (), <span class="comment">// expected result
             </span><span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;Decompression output size limit was not enforced&quot;</span>),
         }
     }

     <span class="attribute">#[test]
     </span><span class="kw">fn </span>test_decompress_slice_iter_to_slice() {
         <span class="comment">// one slice
         </span><span class="kw">let </span><span class="kw-2">mut </span>out = [<span class="number">0_u8</span>; <span class="number">12_usize</span>];
         <span class="kw">let </span>r =
             decompress_slice_iter_to_slice(<span class="kw-2">&amp;mut </span>out, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>ENCODED[..]).into_iter(), <span class="bool-val">true</span>, <span class="bool-val">false</span>);
         <span class="macro">assert_eq!</span>(r, <span class="prelude-val">Ok</span>(<span class="number">12</span>));
         <span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>out[..<span class="number">12</span>], <span class="kw-2">&amp;</span><span class="string">b&quot;Hello, zlib!&quot;</span>[..]);

         <span class="comment">// some chunks at a time
         </span><span class="kw">for </span>chunk_size <span class="kw">in </span><span class="number">1</span>..<span class="number">13 </span>{
             <span class="comment">// Note: because of https://github.com/Frommi/miniz_oxide/issues/110 our
             // out buffer needs to have +1 byte available when the chunk size cuts
             // the adler32 data off from the last actual data.
             </span><span class="kw">let </span><span class="kw-2">mut </span>out = [<span class="number">0_u8</span>; <span class="number">12_usize </span>+ <span class="number">1</span>];
             <span class="kw">let </span>r =
                 decompress_slice_iter_to_slice(<span class="kw-2">&amp;mut </span>out, ENCODED.chunks(chunk_size), <span class="bool-val">true</span>, <span class="bool-val">false</span>);
             <span class="macro">assert_eq!</span>(r, <span class="prelude-val">Ok</span>(<span class="number">12</span>));
             <span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>out[..<span class="number">12</span>], <span class="kw-2">&amp;</span><span class="string">b&quot;Hello, zlib!&quot;</span>[..]);
         }

         <span class="comment">// output buffer too small
         </span><span class="kw">let </span><span class="kw-2">mut </span>out = [<span class="number">0_u8</span>; <span class="number">3_usize</span>];
         <span class="kw">let </span>r = decompress_slice_iter_to_slice(<span class="kw-2">&amp;mut </span>out, ENCODED.chunks(<span class="number">7</span>), <span class="bool-val">true</span>, <span class="bool-val">false</span>);
         <span class="macro">assert!</span>(r.is_err());
     }
 }
 </code></pre></div>
 </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="miniz_oxide" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>