blob: 46467576d388ab6b3bfaa5637fee0d42a4b303c3 [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/miniz_oxide-0.7.1/src/inflate/stream.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>stream.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>
<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>
</pre><pre class="rust"><code><span class="doccomment">//! Extra streaming decompression functionality.
//!
//! As of now this is mainly intended for use to build a higher-level wrapper.
</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;
<span class="kw">use </span>core::{cmp, mem};
<span class="kw">use </span><span class="kw">crate</span>::inflate::core::{decompress, inflate_flags, DecompressorOxide, TINFL_LZ_DICT_SIZE};
<span class="kw">use </span><span class="kw">crate</span>::inflate::TINFLStatus;
<span class="kw">use crate</span>::{DataFormat, MZError, MZFlush, MZResult, MZStatus, StreamResult};
<span class="doccomment">/// Tag that determines reset policy of [InflateState](struct.InflateState.html)
</span><span class="kw">pub trait </span>ResetPolicy {
<span class="doccomment">/// Performs reset
</span><span class="kw">fn </span>reset(<span class="kw-2">&amp;</span><span class="self">self</span>, state: <span class="kw-2">&amp;mut </span>InflateState);
}
<span class="doccomment">/// Resets state, without performing expensive ops (e.g. zeroing buffer)
///
/// Note that not zeroing buffer can lead to security issues when dealing with untrusted input.
</span><span class="kw">pub struct </span>MinReset;
<span class="kw">impl </span>ResetPolicy <span class="kw">for </span>MinReset {
<span class="kw">fn </span>reset(<span class="kw-2">&amp;</span><span class="self">self</span>, state: <span class="kw-2">&amp;mut </span>InflateState) {
state.decompressor().init();
state.dict_ofs = <span class="number">0</span>;
state.dict_avail = <span class="number">0</span>;
state.first_call = <span class="bool-val">true</span>;
state.has_flushed = <span class="bool-val">false</span>;
state.last_status = TINFLStatus::NeedsMoreInput;
}
}
<span class="doccomment">/// Resets state and zero memory, continuing to use the same data format.
</span><span class="kw">pub struct </span>ZeroReset;
<span class="kw">impl </span>ResetPolicy <span class="kw">for </span>ZeroReset {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>reset(<span class="kw-2">&amp;</span><span class="self">self</span>, state: <span class="kw-2">&amp;mut </span>InflateState) {
MinReset.reset(state);
state.dict = [<span class="number">0</span>; TINFL_LZ_DICT_SIZE];
}
}
<span class="doccomment">/// Full reset of the state, including zeroing memory.
///
/// Requires to provide new data format.
</span><span class="kw">pub struct </span>FullReset(<span class="kw">pub </span>DataFormat);
<span class="kw">impl </span>ResetPolicy <span class="kw">for </span>FullReset {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>reset(<span class="kw-2">&amp;</span><span class="self">self</span>, state: <span class="kw-2">&amp;mut </span>InflateState) {
ZeroReset.reset(state);
state.data_format = <span class="self">self</span>.<span class="number">0</span>;
}
}
<span class="doccomment">/// A struct that compbines a decompressor with extra data for streaming decompression.
///
</span><span class="kw">pub struct </span>InflateState {
<span class="doccomment">/// Inner decompressor struct
</span>decomp: DecompressorOxide,
<span class="doccomment">/// Buffer of input bytes for matches.
/// TODO: Could probably do this a bit cleaner with some
/// Cursor-like class.
/// We may also look into whether we need to keep a buffer here, or just one in the
/// decompressor struct.
</span>dict: [u8; TINFL_LZ_DICT_SIZE],
<span class="doccomment">/// Where in the buffer are we currently at?
</span>dict_ofs: usize,
<span class="doccomment">/// How many bytes of data to be flushed is there currently in the buffer?
</span>dict_avail: usize,
first_call: bool,
has_flushed: bool,
<span class="doccomment">/// Whether the input data is wrapped in a zlib header and checksum.
/// TODO: This should be stored in the decompressor.
</span>data_format: DataFormat,
last_status: TINFLStatus,
}
<span class="kw">impl </span>Default <span class="kw">for </span>InflateState {
<span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
InflateState {
decomp: DecompressorOxide::default(),
dict: [<span class="number">0</span>; TINFL_LZ_DICT_SIZE],
dict_ofs: <span class="number">0</span>,
dict_avail: <span class="number">0</span>,
first_call: <span class="bool-val">true</span>,
has_flushed: <span class="bool-val">false</span>,
data_format: DataFormat::Raw,
last_status: TINFLStatus::NeedsMoreInput,
}
}
}
<span class="kw">impl </span>InflateState {
<span class="doccomment">/// Create a new state.
///
/// Note that this struct is quite large due to internal buffers, and as such storing it on
/// the stack is not recommended.
///
/// # Parameters
/// `data_format`: Determines whether the compressed data is assumed to wrapped with zlib
/// metadata.
</span><span class="kw">pub fn </span>new(data_format: DataFormat) -&gt; InflateState {
InflateState {
data_format,
..Default::default()
}
}
<span class="doccomment">/// Create a new state on the heap.
///
/// # Parameters
/// `data_format`: Determines whether the compressed data is assumed to wrapped with zlib
/// metadata.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
</span><span class="kw">pub fn </span>new_boxed(data_format: DataFormat) -&gt; Box&lt;InflateState&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>b: Box&lt;InflateState&gt; = Box::default();
b.data_format = data_format;
b
}
<span class="doccomment">/// Access the innner decompressor.
</span><span class="kw">pub fn </span>decompressor(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>DecompressorOxide {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.decomp
}
<span class="doccomment">/// Return the status of the last call to `inflate` with this `InflateState`.
</span><span class="kw">pub const fn </span>last_status(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; TINFLStatus {
<span class="self">self</span>.last_status
}
<span class="doccomment">/// Create a new state using miniz/zlib style window bits parameter.
///
/// The decompressor does not support different window sizes. As such,
/// any positive (&gt;0) value will set the zlib header flag, while a negative one
/// will not.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;with-alloc&quot;</span>)]
</span><span class="kw">pub fn </span>new_boxed_with_window_bits(window_bits: i32) -&gt; Box&lt;InflateState&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>b: Box&lt;InflateState&gt; = Box::default();
b.data_format = DataFormat::from_window_bits(window_bits);
b
}
<span class="attribute">#[inline]
</span><span class="doccomment">/// Reset the decompressor without re-allocating memory, using the given
/// data format.
</span><span class="kw">pub fn </span>reset(<span class="kw-2">&amp;mut </span><span class="self">self</span>, data_format: DataFormat) {
<span class="self">self</span>.reset_as(FullReset(data_format));
}
<span class="attribute">#[inline]
</span><span class="doccomment">/// Resets the state according to specified policy.
</span><span class="kw">pub fn </span>reset_as&lt;T: ResetPolicy&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, policy: T) {
policy.reset(<span class="self">self</span>)
}
}
<span class="doccomment">/// Try to decompress from `input` to `output` with the given [`InflateState`]
///
/// # `flush`
///
/// Generally, the various [`MZFlush`] flags have meaning only on the compression side. They can be
/// supplied here, but the only one that has any semantic meaning is [`MZFlush::Finish`], which is a
/// signal that the stream is expected to finish, and failing to do so is an error. It isn&#39;t
/// necessary to specify it when the stream ends; you&#39;ll still get returned a
/// [`MZStatus::StreamEnd`] anyway. Other values either have no effect or cause errors. It&#39;s
/// likely that you&#39;ll almost always just want to use [`MZFlush::None`].
///
/// # Errors
///
/// Returns [`MZError::Buf`] if the size of the `output` slice is empty or no progress was made due
/// to lack of expected input data, or if called with [`MZFlush::Finish`] and input wasn&#39;t all
/// consumed.
///
/// Returns [`MZError::Data`] if this or a a previous call failed with an error return from
/// [`TINFLStatus`]; probably indicates corrupted data.
///
/// Returns [`MZError::Stream`] when called with [`MZFlush::Full`] (meaningless on
/// decompression), or when called without [`MZFlush::Finish`] after an earlier call with
/// [`MZFlush::Finish`] has been made.
</span><span class="kw">pub fn </span>inflate(
state: <span class="kw-2">&amp;mut </span>InflateState,
input: <span class="kw-2">&amp;</span>[u8],
output: <span class="kw-2">&amp;mut </span>[u8],
flush: MZFlush,
) -&gt; StreamResult {
<span class="kw">let </span><span class="kw-2">mut </span>bytes_consumed = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>bytes_written = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>next_in = input;
<span class="kw">let </span><span class="kw-2">mut </span>next_out = output;
<span class="kw">if </span>flush == MZFlush::Full {
<span class="kw">return </span>StreamResult::error(MZError::Stream);
}
<span class="kw">let </span><span class="kw-2">mut </span>decomp_flags = <span class="kw">if </span>state.data_format == DataFormat::Zlib {
inflate_flags::TINFL_FLAG_COMPUTE_ADLER32
} <span class="kw">else </span>{
inflate_flags::TINFL_FLAG_IGNORE_ADLER32
};
<span class="kw">if </span>(state.data_format == DataFormat::Zlib)
| (state.data_format == DataFormat::ZLibIgnoreChecksum)
{
decomp_flags |= inflate_flags::TINFL_FLAG_PARSE_ZLIB_HEADER;
}
<span class="kw">let </span>first_call = state.first_call;
state.first_call = <span class="bool-val">false</span>;
<span class="kw">if </span>(state.last_status <span class="kw">as </span>i32) &lt; <span class="number">0 </span>{
<span class="kw">return </span>StreamResult::error(MZError::Data);
}
<span class="kw">if </span>state.has_flushed &amp;&amp; (flush != MZFlush::Finish) {
<span class="kw">return </span>StreamResult::error(MZError::Stream);
}
state.has_flushed |= flush == MZFlush::Finish;
<span class="kw">if </span>(flush == MZFlush::Finish) &amp;&amp; first_call {
decomp_flags |= inflate_flags::TINFL_FLAG_USING_NON_WRAPPING_OUTPUT_BUF;
<span class="kw">let </span>status = decompress(<span class="kw-2">&amp;mut </span>state.decomp, next_in, next_out, <span class="number">0</span>, decomp_flags);
<span class="kw">let </span>in_bytes = status.<span class="number">1</span>;
<span class="kw">let </span>out_bytes = status.<span class="number">2</span>;
<span class="kw">let </span>status = status.<span class="number">0</span>;
state.last_status = status;
bytes_consumed += in_bytes;
bytes_written += out_bytes;
<span class="kw">let </span>ret_status = {
<span class="kw">if </span>(status <span class="kw">as </span>i32) &lt; <span class="number">0 </span>{
<span class="prelude-val">Err</span>(MZError::Data)
} <span class="kw">else if </span>status != TINFLStatus::Done {
state.last_status = TINFLStatus::Failed;
<span class="prelude-val">Err</span>(MZError::Buf)
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(MZStatus::StreamEnd)
}
};
<span class="kw">return </span>StreamResult {
bytes_consumed,
bytes_written,
status: ret_status,
};
}
<span class="kw">if </span>flush != MZFlush::Finish {
decomp_flags |= inflate_flags::TINFL_FLAG_HAS_MORE_INPUT;
}
<span class="kw">if </span>state.dict_avail != <span class="number">0 </span>{
bytes_written += push_dict_out(state, <span class="kw-2">&amp;mut </span>next_out);
<span class="kw">return </span>StreamResult {
bytes_consumed,
bytes_written,
status: <span class="prelude-val">Ok</span>(
<span class="kw">if </span>(state.last_status == TINFLStatus::Done) &amp;&amp; (state.dict_avail == <span class="number">0</span>) {
MZStatus::StreamEnd
} <span class="kw">else </span>{
MZStatus::Ok
},
),
};
}
<span class="kw">let </span>status = inflate_loop(
state,
<span class="kw-2">&amp;mut </span>next_in,
<span class="kw-2">&amp;mut </span>next_out,
<span class="kw-2">&amp;mut </span>bytes_consumed,
<span class="kw-2">&amp;mut </span>bytes_written,
decomp_flags,
flush,
);
StreamResult {
bytes_consumed,
bytes_written,
status,
}
}
<span class="kw">fn </span>inflate_loop(
state: <span class="kw-2">&amp;mut </span>InflateState,
next_in: <span class="kw-2">&amp;mut &amp;</span>[u8],
next_out: <span class="kw-2">&amp;mut &amp;mut </span>[u8],
total_in: <span class="kw-2">&amp;mut </span>usize,
total_out: <span class="kw-2">&amp;mut </span>usize,
decomp_flags: u32,
flush: MZFlush,
) -&gt; MZResult {
<span class="kw">let </span>orig_in_len = next_in.len();
<span class="kw">loop </span>{
<span class="kw">let </span>status = decompress(
<span class="kw-2">&amp;mut </span>state.decomp,
<span class="kw-2">*</span>next_in,
<span class="kw-2">&amp;mut </span>state.dict,
state.dict_ofs,
decomp_flags,
);
<span class="kw">let </span>in_bytes = status.<span class="number">1</span>;
<span class="kw">let </span>out_bytes = status.<span class="number">2</span>;
<span class="kw">let </span>status = status.<span class="number">0</span>;
state.last_status = status;
<span class="kw-2">*</span>next_in = <span class="kw-2">&amp;</span>next_in[in_bytes..];
<span class="kw-2">*</span>total_in += in_bytes;
state.dict_avail = out_bytes;
<span class="kw-2">*</span>total_out += push_dict_out(state, next_out);
<span class="comment">// The stream was corrupted, and decompression failed.
</span><span class="kw">if </span>(status <span class="kw">as </span>i32) &lt; <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(MZError::Data);
}
<span class="comment">// The decompressor has flushed all it&#39;s data and is waiting for more input, but
// there was no more input provided.
</span><span class="kw">if </span>(status == TINFLStatus::NeedsMoreInput) &amp;&amp; orig_in_len == <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(MZError::Buf);
}
<span class="kw">if </span>flush == MZFlush::Finish {
<span class="kw">if </span>status == TINFLStatus::Done {
<span class="comment">// There is not enough space in the output buffer to flush the remaining
// decompressed data in the internal buffer.
</span><span class="kw">return if </span>state.dict_avail != <span class="number">0 </span>{
<span class="prelude-val">Err</span>(MZError::Buf)
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(MZStatus::StreamEnd)
};
<span class="comment">// No more space in the output buffer, but we&#39;re not done.
</span>} <span class="kw">else if </span>next_out.is_empty() {
<span class="kw">return </span><span class="prelude-val">Err</span>(MZError::Buf);
}
} <span class="kw">else </span>{
<span class="comment">// We&#39;re not expected to finish, so it&#39;s fine if we can&#39;t flush everything yet.
</span><span class="kw">let </span>empty_buf = next_in.is_empty() || next_out.is_empty();
<span class="kw">if </span>(status == TINFLStatus::Done) || empty_buf || (state.dict_avail != <span class="number">0</span>) {
<span class="kw">return if </span>(status == TINFLStatus::Done) &amp;&amp; (state.dict_avail == <span class="number">0</span>) {
<span class="comment">// No more data left, we&#39;re done.
</span><span class="prelude-val">Ok</span>(MZStatus::StreamEnd)
} <span class="kw">else </span>{
<span class="comment">// Ok for now, still waiting for more input data or output space.
</span><span class="prelude-val">Ok</span>(MZStatus::Ok)
};
}
}
}
}
<span class="kw">fn </span>push_dict_out(state: <span class="kw-2">&amp;mut </span>InflateState, next_out: <span class="kw-2">&amp;mut &amp;mut </span>[u8]) -&gt; usize {
<span class="kw">let </span>n = cmp::min(state.dict_avail <span class="kw">as </span>usize, next_out.len());
(next_out[..n]).copy_from_slice(<span class="kw-2">&amp;</span>state.dict[state.dict_ofs..state.dict_ofs + n]);
<span class="kw-2">*</span>next_out = <span class="kw-2">&amp;mut </span>mem::take(next_out)[n..];
state.dict_avail -= n;
state.dict_ofs = (state.dict_ofs + (n)) &amp; (TINFL_LZ_DICT_SIZE - <span class="number">1</span>);
n
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use super</span>::{inflate, InflateState};
<span class="kw">use crate</span>::{DataFormat, MZFlush, MZStatus};
<span class="kw">use </span>alloc::vec;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_state() {
<span class="kw">let </span>encoded = [
<span class="number">120u8</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="kw">let </span><span class="kw-2">mut </span>out = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">50</span>];
<span class="kw">let </span><span class="kw-2">mut </span>state = InflateState::new_boxed(DataFormat::Zlib);
<span class="kw">let </span>res = inflate(<span class="kw-2">&amp;mut </span>state, <span class="kw-2">&amp;</span>encoded, <span class="kw-2">&amp;mut </span>out, MZFlush::Finish);
<span class="kw">let </span>status = res.status.expect(<span class="string">&quot;Failed to decompress!&quot;</span>);
<span class="macro">assert_eq!</span>(status, MZStatus::StreamEnd);
<span class="macro">assert_eq!</span>(out[..res.bytes_written <span class="kw">as </span>usize], <span class="string">b&quot;Hello, zlib!&quot;</span>[..]);
<span class="macro">assert_eq!</span>(res.bytes_consumed, encoded.len());
state.reset_as(<span class="kw">super</span>::ZeroReset);
out.iter_mut().map(|x| <span class="kw-2">*</span>x = <span class="number">0</span>).count();
<span class="kw">let </span>res = inflate(<span class="kw-2">&amp;mut </span>state, <span class="kw-2">&amp;</span>encoded, <span class="kw-2">&amp;mut </span>out, MZFlush::Finish);
<span class="kw">let </span>status = res.status.expect(<span class="string">&quot;Failed to decompress!&quot;</span>);
<span class="macro">assert_eq!</span>(status, MZStatus::StreamEnd);
<span class="macro">assert_eq!</span>(out[..res.bytes_written <span class="kw">as </span>usize], <span class="string">b&quot;Hello, zlib!&quot;</span>[..]);
<span class="macro">assert_eq!</span>(res.bytes_consumed, encoded.len());
state.reset_as(<span class="kw">super</span>::MinReset);
out.iter_mut().map(|x| <span class="kw-2">*</span>x = <span class="number">0</span>).count();
<span class="kw">let </span>res = inflate(<span class="kw-2">&amp;mut </span>state, <span class="kw-2">&amp;</span>encoded, <span class="kw-2">&amp;mut </span>out, MZFlush::Finish);
<span class="kw">let </span>status = res.status.expect(<span class="string">&quot;Failed to decompress!&quot;</span>);
<span class="macro">assert_eq!</span>(status, MZStatus::StreamEnd);
<span class="macro">assert_eq!</span>(out[..res.bytes_written <span class="kw">as </span>usize], <span class="string">b&quot;Hello, zlib!&quot;</span>[..]);
<span class="macro">assert_eq!</span>(res.bytes_consumed, encoded.len());
<span class="macro">assert_eq!</span>(state.decompressor().adler32(), <span class="prelude-val">Some</span>(<span class="number">459605011</span>));
<span class="comment">// Test state when not computing adler.
</span>state = InflateState::new_boxed(DataFormat::ZLibIgnoreChecksum);
out.iter_mut().map(|x| <span class="kw-2">*</span>x = <span class="number">0</span>).count();
<span class="kw">let </span>res = inflate(<span class="kw-2">&amp;mut </span>state, <span class="kw-2">&amp;</span>encoded, <span class="kw-2">&amp;mut </span>out, MZFlush::Finish);
<span class="kw">let </span>status = res.status.expect(<span class="string">&quot;Failed to decompress!&quot;</span>);
<span class="macro">assert_eq!</span>(status, MZStatus::StreamEnd);
<span class="macro">assert_eq!</span>(out[..res.bytes_written <span class="kw">as </span>usize], <span class="string">b&quot;Hello, zlib!&quot;</span>[..]);
<span class="macro">assert_eq!</span>(res.bytes_consumed, encoded.len());
<span class="comment">// Not computed, so should be Some(1)
</span><span class="macro">assert_eq!</span>(state.decompressor().adler32(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
<span class="comment">// Should still have the checksum read from the header file.
</span><span class="macro">assert_eq!</span>(state.decompressor().adler32_header(), <span class="prelude-val">Some</span>(<span class="number">459605011</span>))
}
}
</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>