<!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 to the Rust file `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/deflate-0.7.20/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../deflate/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! An implementation an encoder using [DEFLATE](http://www.gzip.org/zlib/rfc-deflate.html)</span>
<span class="doccomment">//! compression algorightm in pure rust.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This library provides functions to compress data using the DEFLATE algorithm,</span>
<span class="doccomment">//! optionally wrapped using the [zlib](https://tools.ietf.org/html/rfc1950) or</span>
<span class="doccomment">//! [gzip](http://www.gzip.org/zlib/rfc-gzip.html) formats.</span>
<span class="doccomment">//! The current implementation is still a bit lacking speed-wise compared to C-libraries</span>
<span class="doccomment">//! like zlib and miniz.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The deflate algorithm is an older compression algorithm that is still widely used today,</span>
<span class="doccomment">//! by e.g html headers, the `.png` inage format, the unix `gzip` program and commonly in `.zip`</span>
<span class="doccomment">//! files. The `zlib` and `gzip` formats are wrappers around DEFLATE-compressed data, containing</span>
<span class="doccomment">//! some extra metadata and a checksum to validate the integrity of the raw data.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The deflate algorithm does not perform as well as newer algorhitms used in file formats such as</span>
<span class="doccomment">//! `.7z`, `.rar`, `.xz` and `.bz2`, and is thus not the ideal choice for applications where</span>
<span class="doccomment">//! the `DEFLATE` format (with or without wrappers) is not required.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Support for the gzip wrapper (the wrapper that is used in `.gz` files) is disabled by default,</span>
<span class="doccomment">//! but can be enabled with the `gzip` feature.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! As this library is still in development, the compression output may change slightly</span>
<span class="doccomment">//! between versions.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Examples:</span>
<span class="doccomment">//! ## Simple compression function:</span>
<span class="doccomment">//! ``` rust</span>
<span class="doccomment">//! use deflate::deflate_bytes;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let data = b"Some data";</span>
<span class="doccomment">//! let compressed = deflate_bytes(data);</span>
<span class="doccomment">//! # let _ = compressed;</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Using a writer:</span>
<span class="doccomment">//! ``` rust</span>
<span class="doccomment">//! use std::io::Write;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! use deflate::Compression;</span>
<span class="doccomment">//! use deflate::write::ZlibEncoder;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! let data = b"This is some test data";</span>
<span class="doccomment">//! let mut encoder = ZlibEncoder::new(Vec::new(), Compression::Default);</span>
<span class="doccomment">//! encoder.write_all(data).expect("Write error!");</span>
<span class="doccomment">//! let compressed_data = encoder.finish().expect("Failed to finish compression!");</span>
<span class="doccomment">//! # let _ = compressed_data;</span>
<span class="doccomment">//! ```</span>
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"benchmarks"</span>, <span class="ident">test</span>), <span class="ident">feature</span>(<span class="ident">test</span>))]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">test</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"benchmarks"</span>))]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">test</span> <span class="kw">as</span> <span class="ident">test_std</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">flate2</span>;
<span class="comment">// #[cfg(test)]</span>
<span class="comment">// extern crate inflate;</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">adler32</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">byteorder</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">gzip_header</span>;
<span class="kw">mod</span> <span class="ident">compression_options</span>;
<span class="kw">mod</span> <span class="ident">huffman_table</span>;
<span class="kw">mod</span> <span class="ident">lz77</span>;
<span class="kw">mod</span> <span class="ident">lzvalue</span>;
<span class="kw">mod</span> <span class="ident">chained_hash_table</span>;
<span class="kw">mod</span> <span class="ident">length_encode</span>;
<span class="kw">mod</span> <span class="ident">output_writer</span>;
<span class="kw">mod</span> <span class="ident">stored_block</span>;
<span class="kw">mod</span> <span class="ident">huffman_lengths</span>;
<span class="kw">mod</span> <span class="ident">zlib</span>;
<span class="kw">mod</span> <span class="ident">checksum</span>;
<span class="kw">mod</span> <span class="ident">bit_reverse</span>;
<span class="kw">mod</span> <span class="ident">bitstream</span>;
<span class="kw">mod</span> <span class="ident">encoder_state</span>;
<span class="kw">mod</span> <span class="ident">matching</span>;
<span class="kw">mod</span> <span class="ident">input_buffer</span>;
<span class="kw">mod</span> <span class="ident">deflate_state</span>;
<span class="kw">mod</span> <span class="ident">compress</span>;
<span class="kw">mod</span> <span class="ident">rle</span>;
<span class="kw">mod</span> <span class="ident">writer</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">test_utils</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
<span class="kw">use</span> <span class="ident">byteorder</span>::<span class="ident">BigEndian</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">use</span> <span class="ident">gzip_header</span>::<span class="ident">GzBuilder</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">use</span> <span class="ident">gzip_header</span>::<span class="ident">Crc</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">use</span> <span class="ident">byteorder</span>::<span class="ident">LittleEndian</span>;
<span class="kw">use</span> <span class="ident">checksum</span>::<span class="ident">RollingChecksum</span>;
<span class="kw">use</span> <span class="ident">deflate_state</span>::<span class="ident">DeflateState</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">compression_options</span>::{<span class="ident">CompressionOptions</span>, <span class="ident">SpecialOptions</span>, <span class="ident">Compression</span>};
<span class="kw">use</span> <span class="ident">compress</span>::<span class="ident">Flush</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">lz77</span>::<span class="ident">MatchingType</span>;
<span class="kw">use</span> <span class="ident">writer</span>::<span class="ident">compress_until_done</span>;
<span class="doccomment">/// Encoders implementing a `Write` interface.</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">write</span> {
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">writer</span>::{<span class="ident">DeflateEncoder</span>, <span class="ident">ZlibEncoder</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">writer</span>::<span class="ident">gzip</span>::<span class="ident">GzEncoder</span>;
}
<span class="kw">fn</span> <span class="ident">compress_data_dynamic</span><span class="op"><</span><span class="ident">RC</span>: <span class="ident">RollingChecksum</span>, <span class="ident">W</span>: <span class="ident">Write</span><span class="op">></span>(
<span class="ident">input</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>],
<span class="ident">writer</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">W</span>,
<span class="kw-2">mut</span> <span class="ident">checksum</span>: <span class="ident">RC</span>,
<span class="ident">compression_options</span>: <span class="ident">CompressionOptions</span>,
) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
<span class="ident">checksum</span>.<span class="ident">update_from_slice</span>(<span class="ident">input</span>);
<span class="comment">// We use a box here to avoid putting the buffers on the stack</span>
<span class="comment">// It's done here rather than in the structs themselves for now to</span>
<span class="comment">// keep the data close in memory.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">deflate_state</span> <span class="op">=</span> <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">DeflateState</span>::<span class="ident">new</span>(<span class="ident">compression_options</span>, <span class="ident">writer</span>));
<span class="ident">compress_until_done</span>(<span class="ident">input</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">deflate_state</span>, <span class="ident">Flush</span>::<span class="ident">Finish</span>)
}
<span class="doccomment">/// Compress the given slice of bytes with DEFLATE compression.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a `Vec<u8>` of the compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use deflate::{deflate_bytes_conf, Compression};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let data = b"This is some test data";</span>
<span class="doccomment">/// let compressed_data = deflate_bytes_conf(data, Compression::Best);</span>
<span class="doccomment">/// # let _ = compressed_data;</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">deflate_bytes_conf</span><span class="op"><</span><span class="ident">O</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">CompressionOptions</span><span class="op">></span><span class="op">></span>(<span class="ident">input</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">options</span>: <span class="ident">O</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">writer</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">input</span>.<span class="ident">len</span>() <span class="op">/</span> <span class="number">3</span>);
<span class="ident">compress_data_dynamic</span>(
<span class="ident">input</span>,
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">writer</span>,
<span class="ident">checksum</span>::<span class="ident">NoChecksum</span>::<span class="ident">new</span>(),
<span class="ident">options</span>.<span class="ident">into</span>(),
).<span class="ident">expect</span>(<span class="string">"Write error!"</span>);
<span class="ident">writer</span>
}
<span class="doccomment">/// Compress the given slice of bytes with DEFLATE compression using the default compression</span>
<span class="doccomment">/// level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a `Vec<u8>` of the compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use deflate::deflate_bytes;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let data = b"This is some test data";</span>
<span class="doccomment">/// let compressed_data = deflate_bytes(data);</span>
<span class="doccomment">/// # let _ = compressed_data;</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">deflate_bytes</span>(<span class="ident">input</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="ident">deflate_bytes_conf</span>(<span class="ident">input</span>, <span class="ident">Compression</span>::<span class="ident">Default</span>)
}
<span class="doccomment">/// Compress the given slice of bytes with DEFLATE compression, including a zlib header and trailer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a `Vec<u8>` of the compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Zlib dictionaries are not yet suppored.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use deflate::{deflate_bytes_zlib_conf, Compression};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let data = b"This is some test data";</span>
<span class="doccomment">/// let compressed_data = deflate_bytes_zlib_conf(data, Compression::Best);</span>
<span class="doccomment">/// # let _ = compressed_data;</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">deflate_bytes_zlib_conf</span><span class="op"><</span><span class="ident">O</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">CompressionOptions</span><span class="op">></span><span class="op">></span>(<span class="ident">input</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">options</span>: <span class="ident">O</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="kw">use</span> <span class="ident">byteorder</span>::<span class="ident">WriteBytesExt</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">writer</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">input</span>.<span class="ident">len</span>() <span class="op">/</span> <span class="number">3</span>);
<span class="comment">// Write header</span>
<span class="ident">zlib</span>::<span class="ident">write_zlib_header</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">writer</span>, <span class="ident">zlib</span>::<span class="ident">CompressionLevel</span>::<span class="ident">Default</span>)
.<span class="ident">expect</span>(<span class="string">"Write error when writing zlib header!"</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">checksum</span> <span class="op">=</span> <span class="ident">checksum</span>::<span class="ident">Adler32Checksum</span>::<span class="ident">new</span>();
<span class="ident">compress_data_dynamic</span>(<span class="ident">input</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">writer</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">checksum</span>, <span class="ident">options</span>.<span class="ident">into</span>())
.<span class="ident">expect</span>(<span class="string">"Write error when writing compressed data!"</span>);
<span class="kw">let</span> <span class="ident">hash</span> <span class="op">=</span> <span class="ident">checksum</span>.<span class="ident">current_hash</span>();
<span class="ident">writer</span>
.<span class="ident">write_u32</span>::<span class="op"><</span><span class="ident">BigEndian</span><span class="op">></span>(<span class="ident">hash</span>)
.<span class="ident">expect</span>(<span class="string">"Write error when writing checksum!"</span>);
<span class="ident">writer</span>
}
<span class="doccomment">/// Compress the given slice of bytes with DEFLATE compression, including a zlib header and trailer,</span>
<span class="doccomment">/// using the default compression level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a Vec<u8> of the compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Zlib dictionaries are not yet suppored.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use deflate::deflate_bytes_zlib;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let data = b"This is some test data";</span>
<span class="doccomment">/// let compressed_data = deflate_bytes_zlib(data);</span>
<span class="doccomment">/// # let _ = compressed_data;</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">deflate_bytes_zlib</span>(<span class="ident">input</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="ident">deflate_bytes_zlib_conf</span>(<span class="ident">input</span>, <span class="ident">Compression</span>::<span class="ident">Default</span>)
}
<span class="doccomment">/// Compress the given slice of bytes with DEFLATE compression, including a gzip header and trailer</span>
<span class="doccomment">/// using the given gzip header and compression options.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a `Vec<u8>` of the compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// extern crate gzip_header;</span>
<span class="doccomment">/// extern crate deflate;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// use deflate::{deflate_bytes_gzip_conf, Compression};</span>
<span class="doccomment">/// use gzip_header::GzBuilder;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let data = b"This is some test data";</span>
<span class="doccomment">/// let compressed_data = deflate_bytes_gzip_conf(data, Compression::Best, GzBuilder::new());</span>
<span class="doccomment">/// # let _ = compressed_data;</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">deflate_bytes_gzip_conf</span><span class="op"><</span><span class="ident">O</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">CompressionOptions</span><span class="op">></span><span class="op">></span>(
<span class="ident">input</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>],
<span class="ident">options</span>: <span class="ident">O</span>,
<span class="ident">gzip_header</span>: <span class="ident">GzBuilder</span>,
) <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="kw">use</span> <span class="ident">byteorder</span>::<span class="ident">WriteBytesExt</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">writer</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="ident">input</span>.<span class="ident">len</span>() <span class="op">/</span> <span class="number">3</span>);
<span class="comment">// Write header</span>
<span class="ident">writer</span>
.<span class="ident">write_all</span>(<span class="kw-2">&</span><span class="ident">gzip_header</span>.<span class="ident">into_header</span>())
.<span class="ident">expect</span>(<span class="string">"Write error when writing header!"</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">checksum</span> <span class="op">=</span> <span class="ident">checksum</span>::<span class="ident">NoChecksum</span>::<span class="ident">new</span>();
<span class="ident">compress_data_dynamic</span>(<span class="ident">input</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">writer</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">checksum</span>, <span class="ident">options</span>.<span class="ident">into</span>())
.<span class="ident">expect</span>(<span class="string">"Write error when writing compressed data!"</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">crc</span> <span class="op">=</span> <span class="ident">Crc</span>::<span class="ident">new</span>();
<span class="ident">crc</span>.<span class="ident">update</span>(<span class="ident">input</span>);
<span class="ident">writer</span>
.<span class="ident">write_u32</span>::<span class="op"><</span><span class="ident">LittleEndian</span><span class="op">></span>(<span class="ident">crc</span>.<span class="ident">sum</span>())
.<span class="ident">expect</span>(<span class="string">"Write error when writing checksum!"</span>);
<span class="ident">writer</span>
.<span class="ident">write_u32</span>::<span class="op"><</span><span class="ident">LittleEndian</span><span class="op">></span>(<span class="ident">crc</span>.<span class="ident">amt_as_u32</span>())
.<span class="ident">expect</span>(<span class="string">"Write error when writing amt!"</span>);
<span class="ident">writer</span>
}
<span class="doccomment">/// Compress the given slice of bytes with DEFLATE compression, including a gzip header and trailer,</span>
<span class="doccomment">/// using the default compression level, and a gzip header with default values.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a `Vec<u8>` of the compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use deflate::deflate_bytes_gzip;</span>
<span class="doccomment">/// let data = b"This is some test data";</span>
<span class="doccomment">/// let compressed_data = deflate_bytes_gzip(data);</span>
<span class="doccomment">/// # let _ = compressed_data;</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">deflate_bytes_gzip</span>(<span class="ident">input</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="ident">deflate_bytes_gzip_conf</span>(<span class="ident">input</span>, <span class="ident">Compression</span>::<span class="ident">Default</span>, <span class="ident">GzBuilder</span>::<span class="ident">new</span>())
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">test</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>;
<span class="kw">use</span> <span class="ident">test_utils</span>::{<span class="ident">get_test_data</span>, <span class="ident">decompress_to_end</span>, <span class="ident">decompress_zlib</span>};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="kw">use</span> <span class="ident">test_utils</span>::<span class="ident">decompress_gzip</span>;
<span class="kw">type</span> <span class="ident">CO</span> <span class="op">=</span> <span class="ident">CompressionOptions</span>;
<span class="doccomment">/// Write data to the writer in chunks of chunk_size.</span>
<span class="kw">fn</span> <span class="ident">chunked_write</span><span class="op"><</span><span class="ident">W</span>: <span class="ident">Write</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="ident">writer</span>: <span class="ident">W</span>, <span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">chunk_size</span>: <span class="ident">usize</span>) {
<span class="kw">for</span> <span class="ident">chunk</span> <span class="kw">in</span> <span class="ident">data</span>.<span class="ident">chunks</span>(<span class="ident">chunk_size</span>) {
<span class="ident">writer</span>.<span class="ident">write_all</span>(<span class="kw-2">&</span><span class="ident">chunk</span>).<span class="ident">unwrap</span>();
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">dynamic_string_mem</span>() {
<span class="kw">let</span> <span class="ident">test_data</span> <span class="op">=</span> <span class="ident">String</span>::<span class="ident">from</span>(<span class="string">" GNU GENERAL PUBLIC LICENSE"</span>).<span class="ident">into_bytes</span>();
<span class="kw">let</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">deflate_bytes</span>(<span class="kw-2">&</span><span class="ident">test_data</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">compressed</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="ident">test_data</span>.<span class="ident">len</span>());
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">decompress_to_end</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">test_data</span>, <span class="ident">result</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">dynamic_string_file</span>() {
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="ident">get_test_data</span>();
<span class="kw">let</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">deflate_bytes</span>(<span class="kw-2">&</span><span class="ident">input</span>);
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">decompress_to_end</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="kw">for</span> (<span class="ident">n</span>, (<span class="kw-2">&</span><span class="ident">a</span>, <span class="kw-2">&</span><span class="ident">b</span>)) <span class="kw">in</span> <span class="ident">input</span>.<span class="ident">iter</span>().<span class="ident">zip</span>(<span class="ident">result</span>.<span class="ident">iter</span>()).<span class="ident">enumerate</span>() {
<span class="kw">if</span> <span class="ident">a</span> <span class="op">!</span><span class="op">=</span> <span class="ident">b</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"First difference at {}, input: {}, output: {}"</span>, <span class="ident">n</span>, <span class="ident">a</span>, <span class="ident">b</span>);
<span class="macro">println</span><span class="macro">!</span>(
<span class="string">"input: {:?}, output: {:?}"</span>,
<span class="kw-2">&</span><span class="ident">input</span>[<span class="ident">n</span> <span class="op">-</span> <span class="number">3</span>..<span class="ident">n</span> <span class="op">+</span> <span class="number">3</span>],
<span class="kw-2">&</span><span class="ident">result</span>[<span class="ident">n</span> <span class="op">-</span> <span class="number">3</span>..<span class="ident">n</span> <span class="op">+</span> <span class="number">3</span>]
);
<span class="kw">break</span>;
}
}
<span class="comment">// Not using assert_eq here deliberately to avoid massive amounts of output spam</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">input</span> <span class="op">=</span><span class="op">=</span> <span class="ident">result</span>);
<span class="comment">// Check that we actually managed to compress the input</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">compressed</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="ident">input</span>.<span class="ident">len</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">file_rle</span>() {
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="ident">get_test_data</span>();
<span class="kw">let</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">deflate_bytes_conf</span>(<span class="kw-2">&</span><span class="ident">input</span>, <span class="ident">CO</span>::<span class="ident">rle</span>());
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">decompress_to_end</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">input</span> <span class="op">=</span><span class="op">=</span> <span class="ident">result</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">file_zlib</span>() {
<span class="kw">let</span> <span class="ident">test_data</span> <span class="op">=</span> <span class="ident">get_test_data</span>();
<span class="kw">let</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">deflate_bytes_zlib</span>(<span class="kw-2">&</span><span class="ident">test_data</span>);
<span class="comment">// {</span>
<span class="comment">// use std::fs::File;</span>
<span class="comment">// use std::io::Write;</span>
<span class="comment">// let mut f = File::create("out.zlib").unwrap();</span>
<span class="comment">// f.write_all(&compressed).unwrap();</span>
<span class="comment">// }</span>
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"file_zlib compressed(default) length: {}"</span>, <span class="ident">compressed</span>.<span class="ident">len</span>());
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">decompress_zlib</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">test_data</span> <span class="op">=</span><span class="op">=</span> <span class="kw-2">&</span><span class="ident">result</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">compressed</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="ident">test_data</span>.<span class="ident">len</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">zlib_short</span>() {
<span class="kw">let</span> <span class="ident">test_data</span> <span class="op">=</span> [<span class="number">10</span>, <span class="number">10</span>, <span class="number">10</span>, <span class="number">10</span>, <span class="number">10</span>, <span class="number">55</span>];
<span class="ident">roundtrip_zlib</span>(<span class="kw-2">&</span><span class="ident">test_data</span>, <span class="ident">CO</span>::<span class="ident">default</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">zlib_last_block</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">test_data</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">22</span>; <span class="number">32768</span>];
<span class="ident">test_data</span>.<span class="ident">extend</span>(<span class="kw-2">&</span>[<span class="number">5</span>, <span class="number">2</span>, <span class="number">55</span>, <span class="number">11</span>, <span class="number">12</span>]);
<span class="ident">roundtrip_zlib</span>(<span class="kw-2">&</span><span class="ident">test_data</span>, <span class="ident">CO</span>::<span class="ident">default</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">deflate_short</span>() {
<span class="kw">let</span> <span class="ident">test_data</span> <span class="op">=</span> [<span class="number">10</span>, <span class="number">10</span>, <span class="number">10</span>, <span class="number">10</span>, <span class="number">10</span>, <span class="number">55</span>];
<span class="kw">let</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">deflate_bytes</span>(<span class="kw-2">&</span><span class="ident">test_data</span>);
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">decompress_to_end</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="ident">test_data</span>, <span class="ident">result</span>.<span class="ident">as_slice</span>());
<span class="comment">// If block type and compression is selected correctly, this should only take 5 bytes.</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">compressed</span>.<span class="ident">len</span>(), <span class="number">5</span>);
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"gzip"</span>)]</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">gzip</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident">get_test_data</span>();
<span class="kw">let</span> <span class="ident">comment</span> <span class="op">=</span> <span class="string">b"Test"</span>;
<span class="kw">let</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">deflate_bytes_gzip_conf</span>(
<span class="kw-2">&</span><span class="ident">data</span>,
<span class="ident">Compression</span>::<span class="ident">Default</span>,
<span class="ident">GzBuilder</span>::<span class="ident">new</span>().<span class="ident">comment</span>(<span class="kw-2">&</span><span class="ident">comment</span>[..]),
);
<span class="kw">let</span> (<span class="ident">dec</span>, <span class="ident">decompressed</span>) <span class="op">=</span> <span class="ident">decompress_gzip</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dec</span>.<span class="ident">header</span>().<span class="ident">comment</span>().<span class="ident">unwrap</span>(), <span class="ident">comment</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">data</span> <span class="op">=</span><span class="op">=</span> <span class="ident">decompressed</span>);
}
<span class="kw">fn</span> <span class="ident">chunk_test</span>(<span class="ident">chunk_size</span>: <span class="ident">usize</span>, <span class="ident">level</span>: <span class="ident">CompressionOptions</span>) {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="ident">with_capacity</span>(<span class="number">32000</span>);
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident">get_test_data</span>();
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">compressor</span> <span class="op">=</span> <span class="ident">write</span>::<span class="ident">ZlibEncoder</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">compressed</span>, <span class="ident">level</span>);
<span class="ident">chunked_write</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">compressor</span>, <span class="kw-2">&</span><span class="ident">data</span>, <span class="ident">chunk_size</span>);
<span class="ident">compressor</span>.<span class="ident">finish</span>().<span class="ident">unwrap</span>();
}
<span class="kw">let</span> <span class="ident">compressed2</span> <span class="op">=</span> <span class="ident">deflate_bytes_zlib_conf</span>(<span class="kw-2">&</span><span class="ident">data</span>, <span class="ident">level</span>);
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">decompress_zlib</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">res</span> <span class="op">=</span><span class="op">=</span> <span class="ident">data</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">compressed</span>.<span class="ident">len</span>(), <span class="ident">compressed2</span>.<span class="ident">len</span>());
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">compressed</span> <span class="op">=</span><span class="op">=</span> <span class="ident">compressed2</span>);
}
<span class="kw">fn</span> <span class="ident">writer_chunks_level</span>(<span class="ident">level</span>: <span class="ident">CompressionOptions</span>) {
<span class="kw">use</span> <span class="ident">input_buffer</span>::<span class="ident">BUFFER_SIZE</span>;
<span class="kw">let</span> <span class="ident">ct</span> <span class="op">=</span> <span class="op">|</span><span class="ident">n</span><span class="op">|</span> <span class="ident">chunk_test</span>(<span class="ident">n</span>, <span class="ident">level</span>);
<span class="ident">ct</span>(<span class="number">1</span>);
<span class="ident">ct</span>(<span class="number">50</span>);
<span class="ident">ct</span>(<span class="number">400</span>);
<span class="ident">ct</span>(<span class="number">32768</span>);
<span class="ident">ct</span>(<span class="ident">BUFFER_SIZE</span>);
<span class="ident">ct</span>(<span class="number">50000</span>);
<span class="ident">ct</span>((<span class="number">32768</span> <span class="op">*</span> <span class="number">2</span>) <span class="op">+</span> <span class="number">258</span>);
}
<span class="attribute">#[<span class="ident">ignore</span>]</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="doccomment">/// Test the writer by inputing data in one chunk at the time.</span>
<span class="kw">fn</span> <span class="ident">zlib_writer_chunks</span>() {
<span class="ident">writer_chunks_level</span>(<span class="ident">CompressionOptions</span>::<span class="ident">default</span>());
<span class="ident">writer_chunks_level</span>(<span class="ident">CompressionOptions</span>::<span class="ident">fast</span>());
<span class="ident">writer_chunks_level</span>(<span class="ident">CompressionOptions</span>::<span class="ident">rle</span>());
}
<span class="doccomment">/// Check that the frequency values don't overflow.</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">frequency_overflow</span>() {
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">deflate_bytes_conf</span>(
<span class="kw-2">&</span><span class="macro">vec</span><span class="macro">!</span>[<span class="number">5</span>; <span class="number">100000</span>],
<span class="ident">compression_options</span>::<span class="ident">CompressionOptions</span>::<span class="ident">default</span>(),
);
}
<span class="kw">fn</span> <span class="ident">roundtrip_zlib</span>(<span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">level</span>: <span class="ident">CompressionOptions</span>) {
<span class="kw">let</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="ident">deflate_bytes_zlib_conf</span>(<span class="ident">data</span>, <span class="ident">level</span>);
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">decompress_zlib</span>(<span class="kw-2">&</span><span class="ident">compressed</span>);
<span class="kw">if</span> <span class="ident">data</span>.<span class="ident">len</span>() <span class="op"><</span><span class="op">=</span> <span class="number">32</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">res</span>, <span class="ident">data</span>, <span class="string">"Failed with level: {:?}"</span>, <span class="ident">level</span>);
} <span class="kw">else</span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">res</span> <span class="op">=</span><span class="op">=</span> <span class="ident">data</span>, <span class="string">"Failed with level: {:?}"</span>, <span class="ident">level</span>);
}
}
<span class="kw">fn</span> <span class="ident">check_zero</span>(<span class="ident">level</span>: <span class="ident">CompressionOptions</span>) {
<span class="ident">roundtrip_zlib</span>(<span class="kw-2">&</span>[], <span class="ident">level</span>);
}
<span class="doccomment">/// Compress with an empty slice.</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">empty_input</span>() {
<span class="ident">check_zero</span>(<span class="ident">CompressionOptions</span>::<span class="ident">default</span>());
<span class="ident">check_zero</span>(<span class="ident">CompressionOptions</span>::<span class="ident">fast</span>());
<span class="ident">check_zero</span>(<span class="ident">CompressionOptions</span>::<span class="ident">rle</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">one_and_two_values</span>() {
<span class="kw">let</span> <span class="ident">one</span> <span class="op">=</span> <span class="kw-2">&</span>[<span class="number">1</span>][..];
<span class="ident">roundtrip_zlib</span>(<span class="ident">one</span>, <span class="ident">CO</span>::<span class="ident">rle</span>());
<span class="ident">roundtrip_zlib</span>(<span class="ident">one</span>, <span class="ident">CO</span>::<span class="ident">fast</span>());
<span class="ident">roundtrip_zlib</span>(<span class="ident">one</span>, <span class="ident">CO</span>::<span class="ident">default</span>());
<span class="kw">let</span> <span class="ident">two</span> <span class="op">=</span> <span class="kw-2">&</span>[<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>][..];
<span class="ident">roundtrip_zlib</span>(<span class="ident">two</span>, <span class="ident">CO</span>::<span class="ident">rle</span>());
<span class="ident">roundtrip_zlib</span>(<span class="ident">two</span>, <span class="ident">CO</span>::<span class="ident">fast</span>());
<span class="ident">roundtrip_zlib</span>(<span class="ident">two</span>, <span class="ident">CO</span>::<span class="ident">default</span>());
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "deflate";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>