blob: 41613f4096ff83ea18311b14fa5cbe18542d3980 [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/flate2-1.0.26/src/mem.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mem.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="../../flate2/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="../../flate2/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::error::Error;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::slice;
<span class="kw">use </span><span class="kw">crate</span>::ffi::{<span class="self">self</span>, Backend, Deflate, DeflateBackend, ErrorMessage, Inflate, InflateBackend};
<span class="kw">use </span><span class="kw">crate</span>::Compression;
<span class="doccomment">/// Raw in-memory compression stream for blocks of data.
///
/// This type is the building block for the I/O streams in the rest of this
/// crate. It requires more management than the [`Read`]/[`Write`] API but is
/// maximally flexible in terms of accepting input from any source and being
/// able to produce output to any memory location.
///
/// It is recommended to use the I/O stream adaptors over this type as they&#39;re
/// easier to use.
///
/// [`Read`]: https://doc.rust-lang.org/std/io/trait.Read.html
/// [`Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Compress {
inner: Deflate,
}
<span class="doccomment">/// Raw in-memory decompression stream for blocks of data.
///
/// This type is the building block for the I/O streams in the rest of this
/// crate. It requires more management than the [`Read`]/[`Write`] API but is
/// maximally flexible in terms of accepting input from any source and being
/// able to produce output to any memory location.
///
/// It is recommended to use the I/O stream adaptors over this type as they&#39;re
/// easier to use.
///
/// [`Read`]: https://doc.rust-lang.org/std/io/trait.Read.html
/// [`Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Decompress {
inner: Inflate,
}
<span class="doccomment">/// Values which indicate the form of flushing to be used when compressing
/// in-memory data.
</span><span class="attribute">#[derive(Copy, Clone, PartialEq, Eq, Debug)]
#[non_exhaustive]
</span><span class="kw">pub enum </span>FlushCompress {
<span class="doccomment">/// A typical parameter for passing to compression/decompression functions,
/// this indicates that the underlying stream to decide how much data to
/// accumulate before producing output in order to maximize compression.
</span><span class="prelude-val">None </span>= ffi::MZ_NO_FLUSH <span class="kw">as </span>isize,
<span class="doccomment">/// All pending output is flushed to the output buffer and the output is
/// aligned on a byte boundary so that the decompressor can get all input
/// data available so far.
///
/// Flushing may degrade compression for some compression algorithms and so
/// it should only be used when necessary. This will complete the current
/// deflate block and follow it with an empty stored block.
</span>Sync = ffi::MZ_SYNC_FLUSH <span class="kw">as </span>isize,
<span class="doccomment">/// All pending output is flushed to the output buffer, but the output is
/// not aligned to a byte boundary.
///
/// All of the input data so far will be available to the decompressor (as
/// with `Flush::Sync`. This completes the current deflate block and follows
/// it with an empty fixed codes block that is 10 bites long, and it assures
/// that enough bytes are output in order for the decompressor to finish the
/// block before the empty fixed code block.
</span>Partial = ffi::MZ_PARTIAL_FLUSH <span class="kw">as </span>isize,
<span class="doccomment">/// All output is flushed as with `Flush::Sync` and the compression state is
/// reset so decompression can restart from this point if previous
/// compressed data has been damaged or if random access is desired.
///
/// Using this option too often can seriously degrade compression.
</span>Full = ffi::MZ_FULL_FLUSH <span class="kw">as </span>isize,
<span class="doccomment">/// Pending input is processed and pending output is flushed.
///
/// The return value may indicate that the stream is not yet done and more
/// data has yet to be processed.
</span>Finish = ffi::MZ_FINISH <span class="kw">as </span>isize,
}
<span class="doccomment">/// Values which indicate the form of flushing to be used when
/// decompressing in-memory data.
</span><span class="attribute">#[derive(Copy, Clone, PartialEq, Eq, Debug)]
#[non_exhaustive]
</span><span class="kw">pub enum </span>FlushDecompress {
<span class="doccomment">/// A typical parameter for passing to compression/decompression functions,
/// this indicates that the underlying stream to decide how much data to
/// accumulate before producing output in order to maximize compression.
</span><span class="prelude-val">None </span>= ffi::MZ_NO_FLUSH <span class="kw">as </span>isize,
<span class="doccomment">/// All pending output is flushed to the output buffer and the output is
/// aligned on a byte boundary so that the decompressor can get all input
/// data available so far.
///
/// Flushing may degrade compression for some compression algorithms and so
/// it should only be used when necessary. This will complete the current
/// deflate block and follow it with an empty stored block.
</span>Sync = ffi::MZ_SYNC_FLUSH <span class="kw">as </span>isize,
<span class="doccomment">/// Pending input is processed and pending output is flushed.
///
/// The return value may indicate that the stream is not yet done and more
/// data has yet to be processed.
</span>Finish = ffi::MZ_FINISH <span class="kw">as </span>isize,
}
<span class="doccomment">/// The inner state for an error when decompressing
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>DecompressErrorInner {
General { msg: ErrorMessage },
NeedsDictionary(u32),
}
<span class="doccomment">/// Error returned when a decompression object finds that the input stream of
/// bytes was not a valid input stream of bytes.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>DecompressError(<span class="kw">pub</span>(<span class="kw">crate</span>) DecompressErrorInner);
<span class="kw">impl </span>DecompressError {
<span class="doccomment">/// Indicates whether decompression failed due to requiring a dictionary.
///
/// The resulting integer is the Adler-32 checksum of the dictionary
/// required.
</span><span class="kw">pub fn </span>needs_dictionary(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;u32&gt; {
<span class="kw">match </span><span class="self">self</span>.<span class="number">0 </span>{
DecompressErrorInner::NeedsDictionary(adler) =&gt; <span class="prelude-val">Some</span>(adler),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>decompress_failed&lt;T&gt;(msg: ErrorMessage) -&gt; <span class="prelude-ty">Result</span>&lt;T, DecompressError&gt; {
<span class="prelude-val">Err</span>(DecompressError(DecompressErrorInner::General { msg }))
}
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>decompress_need_dict&lt;T&gt;(adler: u32) -&gt; <span class="prelude-ty">Result</span>&lt;T, DecompressError&gt; {
<span class="prelude-val">Err</span>(DecompressError(DecompressErrorInner::NeedsDictionary(
adler,
)))
}
<span class="doccomment">/// Error returned when a compression object is used incorrectly or otherwise
/// generates an error.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>CompressError {
<span class="kw">pub</span>(<span class="kw">crate</span>) msg: ErrorMessage,
}
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>compress_failed&lt;T&gt;(msg: ErrorMessage) -&gt; <span class="prelude-ty">Result</span>&lt;T, CompressError&gt; {
<span class="prelude-val">Err</span>(CompressError { msg })
}
<span class="doccomment">/// Possible status results of compressing some data or successfully
/// decompressing a block of data.
</span><span class="attribute">#[derive(Copy, Clone, PartialEq, Eq, Debug)]
</span><span class="kw">pub enum </span>Status {
<span class="doccomment">/// Indicates success.
///
/// Means that more input may be needed but isn&#39;t available
/// and/or there&#39;s more output to be written but the output buffer is full.
</span><span class="prelude-val">Ok</span>,
<span class="doccomment">/// Indicates that forward progress is not possible due to input or output
/// buffers being empty.
///
/// For compression it means the input buffer needs some more data or the
/// output buffer needs to be freed up before trying again.
///
/// For decompression this means that more input is needed to continue or
/// the output buffer isn&#39;t large enough to contain the result. The function
/// can be called again after fixing both.
</span>BufError,
<span class="doccomment">/// Indicates that all input has been consumed and all output bytes have
/// been written. Decompression/compression should not be called again.
///
/// For decompression with zlib streams the adler-32 of the decompressed
/// data has also been verified.
</span>StreamEnd,
}
<span class="kw">impl </span>Compress {
<span class="doccomment">/// Creates a new object ready for compressing data that it&#39;s given.
///
/// The `level` argument here indicates what level of compression is going
/// to be performed, and the `zlib_header` argument indicates whether the
/// output data should have a zlib header or not.
</span><span class="kw">pub fn </span>new(level: Compression, zlib_header: bool) -&gt; Compress {
Compress {
inner: Deflate::make(level, zlib_header, ffi::MZ_DEFAULT_WINDOW_BITS <span class="kw">as </span>u8),
}
}
<span class="doccomment">/// Creates a new object ready for compressing data that it&#39;s given.
///
/// The `level` argument here indicates what level of compression is going
/// to be performed, and the `zlib_header` argument indicates whether the
/// output data should have a zlib header or not. The `window_bits` parameter
/// indicates the base-2 logarithm of the sliding window size and must be
/// between 9 and 15.
///
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">pub fn </span>new_with_window_bits(
level: Compression,
zlib_header: bool,
window_bits: u8,
) -&gt; Compress {
<span class="macro">assert!</span>(
window_bits &gt; <span class="number">8 </span>&amp;&amp; window_bits &lt; <span class="number">16</span>,
<span class="string">&quot;window_bits must be within 9 ..= 15&quot;
</span>);
Compress {
inner: Deflate::make(level, zlib_header, window_bits),
}
}
<span class="doccomment">/// Creates a new object ready for compressing data that it&#39;s given.
///
/// The `level` argument here indicates what level of compression is going
/// to be performed.
///
/// The Compress object produced by this constructor outputs gzip headers
/// for the compressed data.
///
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">pub fn </span>new_gzip(level: Compression, window_bits: u8) -&gt; Compress {
<span class="macro">assert!</span>(
window_bits &gt; <span class="number">8 </span>&amp;&amp; window_bits &lt; <span class="number">16</span>,
<span class="string">&quot;window_bits must be within 9 ..= 15&quot;
</span>);
Compress {
inner: Deflate::make(level, <span class="bool-val">true</span>, window_bits + <span class="number">16</span>),
}
}
<span class="doccomment">/// Returns the total number of input bytes which have been processed by
/// this compression object.
</span><span class="kw">pub fn </span>total_in(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.inner.total_in()
}
<span class="doccomment">/// Returns the total number of output bytes which have been produced by
/// this compression object.
</span><span class="kw">pub fn </span>total_out(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.inner.total_out()
}
<span class="doccomment">/// Specifies the compression dictionary to use.
///
/// Returns the Adler-32 checksum of the dictionary.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">pub fn </span>set_dictionary(<span class="kw-2">&amp;mut </span><span class="self">self</span>, dictionary: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;u32, CompressError&gt; {
<span class="kw">let </span>stream = <span class="kw-2">&amp;mut *</span><span class="self">self</span>.inner.inner.stream_wrapper;
stream.msg = std::ptr::null_mut();
<span class="kw">let </span>rc = <span class="kw">unsafe </span>{
<span class="macro">assert!</span>(dictionary.len() &lt; ffi::uInt::MAX <span class="kw">as </span>usize);
ffi::deflateSetDictionary(stream, dictionary.as_ptr(), dictionary.len() <span class="kw">as </span>ffi::uInt)
};
<span class="kw">match </span>rc {
ffi::MZ_STREAM_ERROR =&gt; compress_failed(<span class="self">self</span>.inner.inner.msg()),
ffi::MZ_OK =&gt; <span class="prelude-val">Ok</span>(stream.adler <span class="kw">as </span>u32),
c =&gt; <span class="macro">panic!</span>(<span class="string">&quot;unknown return code: {}&quot;</span>, c),
}
}
<span class="doccomment">/// Quickly resets this compressor without having to reallocate anything.
///
/// This is equivalent to dropping this object and then creating a new one.
</span><span class="kw">pub fn </span>reset(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.inner.reset();
}
<span class="doccomment">/// Dynamically updates the compression level.
///
/// This can be used to switch between compression levels for different
/// kinds of data, or it can be used in conjunction with a call to reset
/// to reuse the compressor.
///
/// This may return an error if there wasn&#39;t enough output space to complete
/// the compression of the available input data before changing the
/// compression level. Flushing the stream before calling this method
/// ensures that the function will succeed on the first call.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">pub fn </span>set_level(<span class="kw-2">&amp;mut </span><span class="self">self</span>, level: Compression) -&gt; <span class="prelude-ty">Result</span>&lt;(), CompressError&gt; {
<span class="kw">use </span>std::os::raw::c_int;
<span class="kw">let </span>stream = <span class="kw-2">&amp;mut *</span><span class="self">self</span>.inner.inner.stream_wrapper;
stream.msg = std::ptr::null_mut();
<span class="kw">let </span>rc = <span class="kw">unsafe </span>{ ffi::deflateParams(stream, level.<span class="number">0 </span><span class="kw">as </span>c_int, ffi::MZ_DEFAULT_STRATEGY) };
<span class="kw">match </span>rc {
ffi::MZ_OK =&gt; <span class="prelude-val">Ok</span>(()),
ffi::MZ_BUF_ERROR =&gt; compress_failed(<span class="self">self</span>.inner.inner.msg()),
c =&gt; <span class="macro">panic!</span>(<span class="string">&quot;unknown return code: {}&quot;</span>, c),
}
}
<span class="doccomment">/// Compresses the input data into the output, consuming only as much
/// input as needed and writing as much output as possible.
///
/// The flush option can be any of the available `FlushCompress` parameters.
///
/// To learn how much data was consumed or how much output was produced, use
/// the `total_in` and `total_out` functions before/after this is called.
</span><span class="kw">pub fn </span>compress(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
input: <span class="kw-2">&amp;</span>[u8],
output: <span class="kw-2">&amp;mut </span>[u8],
flush: FlushCompress,
) -&gt; <span class="prelude-ty">Result</span>&lt;Status, CompressError&gt; {
<span class="self">self</span>.inner.compress(input, output, flush)
}
<span class="doccomment">/// Compresses the input data into the extra space of the output, consuming
/// only as much input as needed and writing as much output as possible.
///
/// This function has the same semantics as `compress`, except that the
/// length of `vec` is managed by this function. This will not reallocate
/// the vector provided or attempt to grow it, so space for the output must
/// be reserved in the output vector by the caller before calling this
/// function.
</span><span class="kw">pub fn </span>compress_vec(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
input: <span class="kw-2">&amp;</span>[u8],
output: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;,
flush: FlushCompress,
) -&gt; <span class="prelude-ty">Result</span>&lt;Status, CompressError&gt; {
<span class="kw">let </span>cap = output.capacity();
<span class="kw">let </span>len = output.len();
<span class="kw">unsafe </span>{
<span class="kw">let </span>before = <span class="self">self</span>.total_out();
<span class="kw">let </span>ret = {
<span class="kw">let </span>ptr = output.as_mut_ptr().add(len);
<span class="kw">let </span>out = slice::from_raw_parts_mut(ptr, cap - len);
<span class="self">self</span>.compress(input, out, flush)
};
output.set_len((<span class="self">self</span>.total_out() - before) <span class="kw">as </span>usize + len);
ret
}
}
}
<span class="kw">impl </span>Decompress {
<span class="doccomment">/// Creates a new object ready for decompressing data that it&#39;s given.
///
/// The `zlib_header` argument indicates whether the input data is expected
/// to have a zlib header or not.
</span><span class="kw">pub fn </span>new(zlib_header: bool) -&gt; Decompress {
Decompress {
inner: Inflate::make(zlib_header, ffi::MZ_DEFAULT_WINDOW_BITS <span class="kw">as </span>u8),
}
}
<span class="doccomment">/// Creates a new object ready for decompressing data that it&#39;s given.
///
/// The `zlib_header` argument indicates whether the input data is expected
/// to have a zlib header or not. The `window_bits` parameter indicates the
/// base-2 logarithm of the sliding window size and must be between 9 and 15.
///
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">pub fn </span>new_with_window_bits(zlib_header: bool, window_bits: u8) -&gt; Decompress {
<span class="macro">assert!</span>(
window_bits &gt; <span class="number">8 </span>&amp;&amp; window_bits &lt; <span class="number">16</span>,
<span class="string">&quot;window_bits must be within 9 ..= 15&quot;
</span>);
Decompress {
inner: Inflate::make(zlib_header, window_bits),
}
}
<span class="doccomment">/// Creates a new object ready for decompressing data that it&#39;s given.
///
/// The Decompress object produced by this constructor expects gzip headers
/// for the compressed data.
///
/// # Panics
///
/// If `window_bits` does not fall into the range 9 ..= 15,
/// `new_with_window_bits` will panic.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">pub fn </span>new_gzip(window_bits: u8) -&gt; Decompress {
<span class="macro">assert!</span>(
window_bits &gt; <span class="number">8 </span>&amp;&amp; window_bits &lt; <span class="number">16</span>,
<span class="string">&quot;window_bits must be within 9 ..= 15&quot;
</span>);
Decompress {
inner: Inflate::make(<span class="bool-val">true</span>, window_bits + <span class="number">16</span>),
}
}
<span class="doccomment">/// Returns the total number of input bytes which have been processed by
/// this decompression object.
</span><span class="kw">pub fn </span>total_in(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.inner.total_in()
}
<span class="doccomment">/// Returns the total number of output bytes which have been produced by
/// this decompression object.
</span><span class="kw">pub fn </span>total_out(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u64 {
<span class="self">self</span>.inner.total_out()
}
<span class="doccomment">/// Decompresses the input data into the output, consuming only as much
/// input as needed and writing as much output as possible.
///
/// The flush option can be any of the available `FlushDecompress` parameters.
///
/// If the first call passes `FlushDecompress::Finish` it is assumed that
/// the input and output buffers are both sized large enough to decompress
/// the entire stream in a single call.
///
/// A flush value of `FlushDecompress::Finish` indicates that there are no
/// more source bytes available beside what&#39;s already in the input buffer,
/// and the output buffer is large enough to hold the rest of the
/// decompressed data.
///
/// To learn how much data was consumed or how much output was produced, use
/// the `total_in` and `total_out` functions before/after this is called.
///
/// # Errors
///
/// If the input data to this instance of `Decompress` is not a valid
/// zlib/deflate stream then this function may return an instance of
/// `DecompressError` to indicate that the stream of input bytes is corrupted.
</span><span class="kw">pub fn </span>decompress(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
input: <span class="kw-2">&amp;</span>[u8],
output: <span class="kw-2">&amp;mut </span>[u8],
flush: FlushDecompress,
) -&gt; <span class="prelude-ty">Result</span>&lt;Status, DecompressError&gt; {
<span class="self">self</span>.inner.decompress(input, output, flush)
}
<span class="doccomment">/// Decompresses the input data into the extra space in the output vector
/// specified by `output`.
///
/// This function has the same semantics as `decompress`, except that the
/// length of `vec` is managed by this function. This will not reallocate
/// the vector provided or attempt to grow it, so space for the output must
/// be reserved in the output vector by the caller before calling this
/// function.
///
/// # Errors
///
/// If the input data to this instance of `Decompress` is not a valid
/// zlib/deflate stream then this function may return an instance of
/// `DecompressError` to indicate that the stream of input bytes is corrupted.
</span><span class="kw">pub fn </span>decompress_vec(
<span class="kw-2">&amp;mut </span><span class="self">self</span>,
input: <span class="kw-2">&amp;</span>[u8],
output: <span class="kw-2">&amp;mut </span>Vec&lt;u8&gt;,
flush: FlushDecompress,
) -&gt; <span class="prelude-ty">Result</span>&lt;Status, DecompressError&gt; {
<span class="kw">let </span>cap = output.capacity();
<span class="kw">let </span>len = output.len();
<span class="kw">unsafe </span>{
<span class="kw">let </span>before = <span class="self">self</span>.total_out();
<span class="kw">let </span>ret = {
<span class="kw">let </span>ptr = output.as_mut_ptr().add(len);
<span class="kw">let </span>out = slice::from_raw_parts_mut(ptr, cap - len);
<span class="self">self</span>.decompress(input, out, flush)
};
output.set_len((<span class="self">self</span>.total_out() - before) <span class="kw">as </span>usize + len);
ret
}
}
<span class="doccomment">/// Specifies the decompression dictionary to use.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">pub fn </span>set_dictionary(<span class="kw-2">&amp;mut </span><span class="self">self</span>, dictionary: <span class="kw-2">&amp;</span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;u32, DecompressError&gt; {
<span class="kw">let </span>stream = <span class="kw-2">&amp;mut *</span><span class="self">self</span>.inner.inner.stream_wrapper;
stream.msg = std::ptr::null_mut();
<span class="kw">let </span>rc = <span class="kw">unsafe </span>{
<span class="macro">assert!</span>(dictionary.len() &lt; ffi::uInt::MAX <span class="kw">as </span>usize);
ffi::inflateSetDictionary(stream, dictionary.as_ptr(), dictionary.len() <span class="kw">as </span>ffi::uInt)
};
<span class="kw">match </span>rc {
ffi::MZ_STREAM_ERROR =&gt; decompress_failed(<span class="self">self</span>.inner.inner.msg()),
ffi::MZ_DATA_ERROR =&gt; decompress_need_dict(stream.adler <span class="kw">as </span>u32),
ffi::MZ_OK =&gt; <span class="prelude-val">Ok</span>(stream.adler <span class="kw">as </span>u32),
c =&gt; <span class="macro">panic!</span>(<span class="string">&quot;unknown return code: {}&quot;</span>, c),
}
}
<span class="doccomment">/// Performs the equivalent of replacing this decompression state with a
/// freshly allocated copy.
///
/// This function may not allocate memory, though, and attempts to reuse any
/// previously existing resources.
///
/// The argument provided here indicates whether the reset state will
/// attempt to decode a zlib header first or not.
</span><span class="kw">pub fn </span>reset(<span class="kw-2">&amp;mut </span><span class="self">self</span>, zlib_header: bool) {
<span class="self">self</span>.inner.reset(zlib_header);
}
}
<span class="kw">impl </span>Error <span class="kw">for </span>DecompressError {}
<span class="kw">impl </span>DecompressError {
<span class="doccomment">/// Retrieve the implementation&#39;s message about why the operation failed, if one exists.
</span><span class="kw">pub fn </span>message(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt; {
<span class="kw">match </span><span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0 </span>{
DecompressErrorInner::General { msg } =&gt; msg.get(),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="kw">impl </span>From&lt;DecompressError&gt; <span class="kw">for </span>io::Error {
<span class="kw">fn </span>from(data: DecompressError) -&gt; io::Error {
io::Error::new(io::ErrorKind::Other, data)
}
}
<span class="kw">impl </span>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>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">let </span>msg = <span class="kw">match </span><span class="kw-2">&amp;</span><span class="self">self</span>.<span class="number">0 </span>{
DecompressErrorInner::General { msg } =&gt; msg.get(),
DecompressErrorInner::NeedsDictionary { .. } =&gt; <span class="prelude-val">Some</span>(<span class="string">&quot;requires a dictionary&quot;</span>),
};
<span class="kw">match </span>msg {
<span class="prelude-val">Some</span>(msg) =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;deflate decompression error: {}&quot;</span>, msg),
<span class="prelude-val">None </span>=&gt; <span class="macro">write!</span>(f, <span class="string">&quot;deflate decompression error&quot;</span>),
}
}
}
<span class="kw">impl </span>Error <span class="kw">for </span>CompressError {}
<span class="kw">impl </span>CompressError {
<span class="doccomment">/// Retrieve the implementation&#39;s message about why the operation failed, if one exists.
</span><span class="kw">pub fn </span>message(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt; {
<span class="self">self</span>.msg.get()
}
}
<span class="kw">impl </span>From&lt;CompressError&gt; <span class="kw">for </span>io::Error {
<span class="kw">fn </span>from(data: CompressError) -&gt; io::Error {
io::Error::new(io::ErrorKind::Other, data)
}
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>CompressError {
<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>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">match </span><span class="self">self</span>.msg.get() {
<span class="prelude-val">Some</span>(msg) =&gt; <span class="macro">write!</span>(f, <span class="string">&quot;deflate compression error: {}&quot;</span>, msg),
<span class="prelude-val">None </span>=&gt; <span class="macro">write!</span>(f, <span class="string">&quot;deflate compression error&quot;</span>),
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>std::io::Write;
<span class="kw">use </span><span class="kw">crate</span>::write;
<span class="kw">use crate</span>::{Compression, Decompress, FlushDecompress};
<span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
</span><span class="kw">use crate</span>::{Compress, FlushCompress};
<span class="attribute">#[test]
</span><span class="kw">fn </span>issue51() {
<span class="kw">let </span>data = <span class="macro">vec!</span>[
<span class="number">0x1f</span>, <span class="number">0x8b</span>, <span class="number">0x08</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x03</span>, <span class="number">0xb3</span>, <span class="number">0xc9</span>, <span class="number">0x28</span>, <span class="number">0xc9</span>,
<span class="number">0xcd</span>, <span class="number">0xb1</span>, <span class="number">0xe3</span>, <span class="number">0xe5</span>, <span class="number">0xb2</span>, <span class="number">0xc9</span>, <span class="number">0x48</span>, <span class="number">0x4d</span>, <span class="number">0x4c</span>, <span class="number">0xb1</span>, <span class="number">0xb3</span>, <span class="number">0x29</span>, <span class="number">0xc9</span>, <span class="number">0x2c</span>,
<span class="number">0xc9</span>, <span class="number">0x49</span>, <span class="number">0xb5</span>, <span class="number">0x33</span>, <span class="number">0x31</span>, <span class="number">0x30</span>, <span class="number">0x51</span>, <span class="number">0xf0</span>, <span class="number">0xcb</span>, <span class="number">0x2f</span>, <span class="number">0x51</span>, <span class="number">0x70</span>, <span class="number">0xcb</span>, <span class="number">0x2f</span>,
<span class="number">0xcd</span>, <span class="number">0x4b</span>, <span class="number">0xb1</span>, <span class="number">0xd1</span>, <span class="number">0x87</span>, <span class="number">0x08</span>, <span class="number">0xda</span>, <span class="number">0xe8</span>, <span class="number">0x83</span>, <span class="number">0x95</span>, <span class="number">0x00</span>, <span class="number">0x95</span>, <span class="number">0x26</span>, <span class="number">0xe5</span>,
<span class="number">0xa7</span>, <span class="number">0x54</span>, <span class="number">0x2a</span>, <span class="number">0x24</span>, <span class="number">0xa5</span>, <span class="number">0x27</span>, <span class="number">0xe7</span>, <span class="number">0xe7</span>, <span class="number">0xe4</span>, <span class="number">0x17</span>, <span class="number">0xd9</span>, <span class="number">0x2a</span>, <span class="number">0x95</span>, <span class="number">0x67</span>,
<span class="number">0x64</span>, <span class="number">0x96</span>, <span class="number">0xa4</span>, <span class="number">0x2a</span>, <span class="number">0x81</span>, <span class="number">0x8c</span>, <span class="number">0x48</span>, <span class="number">0x4e</span>, <span class="number">0xcd</span>, <span class="number">0x2b</span>, <span class="number">0x49</span>, <span class="number">0x2d</span>, <span class="number">0xb2</span>, <span class="number">0xb3</span>,
<span class="number">0xc9</span>, <span class="number">0x30</span>, <span class="number">0x44</span>, <span class="number">0x37</span>, <span class="number">0x01</span>, <span class="number">0x28</span>, <span class="number">0x62</span>, <span class="number">0xa3</span>, <span class="number">0x0f</span>, <span class="number">0x95</span>, <span class="number">0x06</span>, <span class="number">0xd9</span>, <span class="number">0x05</span>, <span class="number">0x54</span>,
<span class="number">0x04</span>, <span class="number">0xe5</span>, <span class="number">0xe5</span>, <span class="number">0xa5</span>, <span class="number">0x67</span>, <span class="number">0xe6</span>, <span class="number">0x55</span>, <span class="number">0xe8</span>, <span class="number">0x1b</span>, <span class="number">0xea</span>, <span class="number">0x99</span>, <span class="number">0xe9</span>, <span class="number">0x19</span>, <span class="number">0x21</span>,
<span class="number">0xab</span>, <span class="number">0xd0</span>, <span class="number">0x07</span>, <span class="number">0xd9</span>, <span class="number">0x01</span>, <span class="number">0x32</span>, <span class="number">0x53</span>, <span class="number">0x1f</span>, <span class="number">0xea</span>, <span class="number">0x3e</span>, <span class="number">0x00</span>, <span class="number">0x94</span>, <span class="number">0x85</span>, <span class="number">0xeb</span>,
<span class="number">0xe4</span>, <span class="number">0xa8</span>, <span class="number">0x00</span>, <span class="number">0x00</span>, <span class="number">0x00</span>,
];
<span class="kw">let </span><span class="kw-2">mut </span>decoded = Vec::with_capacity(data.len() * <span class="number">2</span>);
<span class="kw">let </span><span class="kw-2">mut </span>d = Decompress::new(<span class="bool-val">false</span>);
<span class="comment">// decompressed whole deflate stream
</span><span class="macro">assert!</span>(d
.decompress_vec(<span class="kw-2">&amp;</span>data[<span class="number">10</span>..], <span class="kw-2">&amp;mut </span>decoded, FlushDecompress::Finish)
.is_ok());
<span class="comment">// decompress data that has nothing to do with the deflate stream (this
// used to panic)
</span>drop(d.decompress_vec(<span class="kw-2">&amp;</span>[<span class="number">0</span>], <span class="kw-2">&amp;mut </span>decoded, FlushDecompress::None));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>reset() {
<span class="kw">let </span>string = <span class="string">&quot;hello world&quot;</span>.as_bytes();
<span class="kw">let </span><span class="kw-2">mut </span>zlib = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>deflate = Vec::new();
<span class="kw">let </span>comp = Compression::default();
write::ZlibEncoder::new(<span class="kw-2">&amp;mut </span>zlib, comp)
.write_all(string)
.unwrap();
write::DeflateEncoder::new(<span class="kw-2">&amp;mut </span>deflate, comp)
.write_all(string)
.unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0</span>; <span class="number">1024</span>];
<span class="kw">let </span><span class="kw-2">mut </span>decoder = Decompress::new(<span class="bool-val">true</span>);
decoder
.decompress(<span class="kw-2">&amp;</span>zlib, <span class="kw-2">&amp;mut </span>dst, FlushDecompress::Finish)
.unwrap();
<span class="macro">assert_eq!</span>(decoder.total_out(), string.len() <span class="kw">as </span>u64);
<span class="macro">assert!</span>(dst.starts_with(string));
decoder.reset(<span class="bool-val">false</span>);
decoder
.decompress(<span class="kw-2">&amp;</span>deflate, <span class="kw-2">&amp;mut </span>dst, FlushDecompress::Finish)
.unwrap();
<span class="macro">assert_eq!</span>(decoder.total_out(), string.len() <span class="kw">as </span>u64);
<span class="macro">assert!</span>(dst.starts_with(string));
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
#[test]
</span><span class="kw">fn </span>set_dictionary_with_zlib_header() {
<span class="kw">let </span>string = <span class="string">&quot;hello, hello!&quot;</span>.as_bytes();
<span class="kw">let </span>dictionary = <span class="string">&quot;hello&quot;</span>.as_bytes();
<span class="kw">let </span><span class="kw-2">mut </span>encoded = Vec::with_capacity(<span class="number">1024</span>);
<span class="kw">let </span><span class="kw-2">mut </span>encoder = Compress::new(Compression::default(), <span class="bool-val">true</span>);
<span class="kw">let </span>dictionary_adler = encoder.set_dictionary(<span class="kw-2">&amp;</span>dictionary).unwrap();
encoder
.compress_vec(string, <span class="kw-2">&amp;mut </span>encoded, FlushCompress::Finish)
.unwrap();
<span class="macro">assert_eq!</span>(encoder.total_in(), string.len() <span class="kw">as </span>u64);
<span class="macro">assert_eq!</span>(encoder.total_out(), encoded.len() <span class="kw">as </span>u64);
<span class="kw">let </span><span class="kw-2">mut </span>decoder = Decompress::new(<span class="bool-val">true</span>);
<span class="kw">let </span><span class="kw-2">mut </span>decoded = [<span class="number">0</span>; <span class="number">1024</span>];
<span class="kw">let </span>decompress_error = decoder
.decompress(<span class="kw-2">&amp;</span>encoded, <span class="kw-2">&amp;mut </span>decoded, FlushDecompress::Finish)
.expect_err(<span class="string">&quot;decompression should fail due to requiring a dictionary&quot;</span>);
<span class="kw">let </span>required_adler = decompress_error.needs_dictionary()
.expect(<span class="string">&quot;the first call to decompress should indicate a dictionary is required along with the required Adler-32 checksum&quot;</span>);
<span class="macro">assert_eq!</span>(required_adler, dictionary_adler,
<span class="string">&quot;the Adler-32 checksum should match the value when the dictionary was set on the compressor&quot;</span>);
<span class="kw">let </span>actual_adler = decoder.set_dictionary(<span class="kw-2">&amp;</span>dictionary).unwrap();
<span class="macro">assert_eq!</span>(required_adler, actual_adler);
<span class="comment">// Decompress the rest of the input to the remainder of the output buffer
</span><span class="kw">let </span>total_in = decoder.total_in();
<span class="kw">let </span>total_out = decoder.total_out();
<span class="kw">let </span>decompress_result = decoder.decompress(
<span class="kw-2">&amp;</span>encoded[total_in <span class="kw">as </span>usize..],
<span class="kw-2">&amp;mut </span>decoded[total_out <span class="kw">as </span>usize..],
FlushDecompress::Finish,
);
<span class="macro">assert!</span>(decompress_result.is_ok());
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>decoded[..decoder.total_out() <span class="kw">as </span>usize], string);
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
#[test]
</span><span class="kw">fn </span>set_dictionary_raw() {
<span class="kw">let </span>string = <span class="string">&quot;hello, hello!&quot;</span>.as_bytes();
<span class="kw">let </span>dictionary = <span class="string">&quot;hello&quot;</span>.as_bytes();
<span class="kw">let </span><span class="kw-2">mut </span>encoded = Vec::with_capacity(<span class="number">1024</span>);
<span class="kw">let </span><span class="kw-2">mut </span>encoder = Compress::new(Compression::default(), <span class="bool-val">false</span>);
encoder.set_dictionary(<span class="kw-2">&amp;</span>dictionary).unwrap();
encoder
.compress_vec(string, <span class="kw-2">&amp;mut </span>encoded, FlushCompress::Finish)
.unwrap();
<span class="macro">assert_eq!</span>(encoder.total_in(), string.len() <span class="kw">as </span>u64);
<span class="macro">assert_eq!</span>(encoder.total_out(), encoded.len() <span class="kw">as </span>u64);
<span class="kw">let </span><span class="kw-2">mut </span>decoder = Decompress::new(<span class="bool-val">false</span>);
decoder.set_dictionary(<span class="kw-2">&amp;</span>dictionary).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>decoded = [<span class="number">0</span>; <span class="number">1024</span>];
<span class="kw">let </span>decompress_result = decoder.decompress(<span class="kw-2">&amp;</span>encoded, <span class="kw-2">&amp;mut </span>decoded, FlushDecompress::Finish);
<span class="macro">assert!</span>(decompress_result.is_ok());
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>decoded[..decoder.total_out() <span class="kw">as </span>usize], string);
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
#[test]
</span><span class="kw">fn </span>test_gzip_flate() {
<span class="kw">let </span>string = <span class="string">&quot;hello, hello!&quot;</span>.as_bytes();
<span class="kw">let </span><span class="kw-2">mut </span>encoded = Vec::with_capacity(<span class="number">1024</span>);
<span class="kw">let </span><span class="kw-2">mut </span>encoder = Compress::new_gzip(Compression::default(), <span class="number">9</span>);
encoder
.compress_vec(string, <span class="kw-2">&amp;mut </span>encoded, FlushCompress::Finish)
.unwrap();
<span class="macro">assert_eq!</span>(encoder.total_in(), string.len() <span class="kw">as </span>u64);
<span class="macro">assert_eq!</span>(encoder.total_out(), encoded.len() <span class="kw">as </span>u64);
<span class="kw">let </span><span class="kw-2">mut </span>decoder = Decompress::new_gzip(<span class="number">9</span>);
<span class="kw">let </span><span class="kw-2">mut </span>decoded = [<span class="number">0</span>; <span class="number">1024</span>];
decoder
.decompress(<span class="kw-2">&amp;</span>encoded, <span class="kw-2">&amp;mut </span>decoded, FlushDecompress::Finish)
.unwrap();
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>decoded[..decoder.total_out() <span class="kw">as </span>usize], string);
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;any_zlib&quot;</span>)]
#[test]
</span><span class="kw">fn </span>test_error_message() {
<span class="kw">let </span><span class="kw-2">mut </span>decoder = Decompress::new(<span class="bool-val">false</span>);
<span class="kw">let </span><span class="kw-2">mut </span>decoded = [<span class="number">0</span>; <span class="number">128</span>];
<span class="kw">let </span>garbage = <span class="string">b&quot;xbvxzi&quot;</span>;
<span class="kw">let </span>err = decoder
.decompress(<span class="kw-2">&amp;*</span>garbage, <span class="kw-2">&amp;mut </span>decoded, FlushDecompress::Finish)
.unwrap_err();
<span class="macro">assert_eq!</span>(err.message(), <span class="prelude-val">Some</span>(<span class="string">&quot;invalid stored block lengths&quot;</span>));
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="flate2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>