| <!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/gz/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::ffi::CString; |
| <span class="kw">use </span>std::io::prelude::<span class="kw-2">*</span>; |
| <span class="kw">use </span>std::time; |
| |
| <span class="kw">use </span><span class="kw">crate</span>::bufreader::BufReader; |
| <span class="kw">use </span><span class="kw">crate</span>::Compression; |
| |
| <span class="kw">pub static </span>FHCRC: u8 = <span class="number">1 </span><< <span class="number">1</span>; |
| <span class="kw">pub static </span>FEXTRA: u8 = <span class="number">1 </span><< <span class="number">2</span>; |
| <span class="kw">pub static </span>FNAME: u8 = <span class="number">1 </span><< <span class="number">3</span>; |
| <span class="kw">pub static </span>FCOMMENT: u8 = <span class="number">1 </span><< <span class="number">4</span>; |
| |
| <span class="kw">pub mod </span>bufread; |
| <span class="kw">pub mod </span>read; |
| <span class="kw">pub mod </span>write; |
| |
| <span class="doccomment">/// A structure representing the header of a gzip stream. |
| /// |
| /// The header can contain metadata about the file that was compressed, if |
| /// present. |
| </span><span class="attribute">#[derive(PartialEq, Clone, Debug, Default)] |
| </span><span class="kw">pub struct </span>GzHeader { |
| extra: <span class="prelude-ty">Option</span><Vec<u8>>, |
| filename: <span class="prelude-ty">Option</span><Vec<u8>>, |
| comment: <span class="prelude-ty">Option</span><Vec<u8>>, |
| operating_system: u8, |
| mtime: u32, |
| } |
| |
| <span class="kw">impl </span>GzHeader { |
| <span class="doccomment">/// Returns the `filename` field of this gzip stream's header, if present. |
| </span><span class="kw">pub fn </span>filename(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[u8]> { |
| <span class="self">self</span>.filename.as_ref().map(|s| <span class="kw-2">&</span>s[..]) |
| } |
| |
| <span class="doccomment">/// Returns the `extra` field of this gzip stream's header, if present. |
| </span><span class="kw">pub fn </span>extra(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[u8]> { |
| <span class="self">self</span>.extra.as_ref().map(|s| <span class="kw-2">&</span>s[..]) |
| } |
| |
| <span class="doccomment">/// Returns the `comment` field of this gzip stream's header, if present. |
| </span><span class="kw">pub fn </span>comment(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>[u8]> { |
| <span class="self">self</span>.comment.as_ref().map(|s| <span class="kw-2">&</span>s[..]) |
| } |
| |
| <span class="doccomment">/// Returns the `operating_system` field of this gzip stream's header. |
| /// |
| /// There are predefined values for various operating systems. |
| /// 255 means that the value is unknown. |
| </span><span class="kw">pub fn </span>operating_system(<span class="kw-2">&</span><span class="self">self</span>) -> u8 { |
| <span class="self">self</span>.operating_system |
| } |
| |
| <span class="doccomment">/// This gives the most recent modification time of the original file being compressed. |
| /// |
| /// The time is in Unix format, i.e., seconds since 00:00:00 GMT, Jan. 1, 1970. |
| /// (Note that this may cause problems for MS-DOS and other systems that use local |
| /// rather than Universal time.) If the compressed data did not come from a file, |
| /// `mtime` is set to the time at which compression started. |
| /// `mtime` = 0 means no time stamp is available. |
| /// |
| /// The usage of `mtime` is discouraged because of Year 2038 problem. |
| </span><span class="kw">pub fn </span>mtime(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| <span class="self">self</span>.mtime |
| } |
| |
| <span class="doccomment">/// Returns the most recent modification time represented by a date-time type. |
| /// Returns `None` if the value of the underlying counter is 0, |
| /// indicating no time stamp is available. |
| /// |
| /// |
| /// The time is measured as seconds since 00:00:00 GMT, Jan. 1 1970. |
| /// See [`mtime`](#method.mtime) for more detail. |
| </span><span class="kw">pub fn </span>mtime_as_datetime(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><time::SystemTime> { |
| <span class="kw">if </span><span class="self">self</span>.mtime == <span class="number">0 </span>{ |
| <span class="prelude-val">None |
| </span>} <span class="kw">else </span>{ |
| <span class="kw">let </span>duration = time::Duration::new(u64::from(<span class="self">self</span>.mtime), <span class="number">0</span>); |
| <span class="kw">let </span>datetime = time::UNIX_EPOCH + duration; |
| <span class="prelude-val">Some</span>(datetime) |
| } |
| } |
| } |
| |
| <span class="doccomment">/// A builder structure to create a new gzip Encoder. |
| /// |
| /// This structure controls header configuration options such as the filename. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use std::io::prelude::*; |
| /// # use std::io; |
| /// use std::fs::File; |
| /// use flate2::GzBuilder; |
| /// use flate2::Compression; |
| /// |
| /// // GzBuilder opens a file and writes a sample string using GzBuilder pattern |
| /// |
| /// # fn sample_builder() -> Result<(), io::Error> { |
| /// let f = File::create("examples/hello_world.gz")?; |
| /// let mut gz = GzBuilder::new() |
| /// .filename("hello_world.txt") |
| /// .comment("test file, please delete") |
| /// .write(f, Compression::default()); |
| /// gz.write_all(b"hello world")?; |
| /// gz.finish()?; |
| /// # Ok(()) |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>GzBuilder { |
| extra: <span class="prelude-ty">Option</span><Vec<u8>>, |
| filename: <span class="prelude-ty">Option</span><CString>, |
| comment: <span class="prelude-ty">Option</span><CString>, |
| operating_system: <span class="prelude-ty">Option</span><u8>, |
| mtime: u32, |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>GzBuilder { |
| <span class="kw">fn </span>default() -> <span class="self">Self </span>{ |
| <span class="self">Self</span>::new() |
| } |
| } |
| |
| <span class="kw">impl </span>GzBuilder { |
| <span class="doccomment">/// Create a new blank builder with no header by default. |
| </span><span class="kw">pub fn </span>new() -> GzBuilder { |
| GzBuilder { |
| extra: <span class="prelude-val">None</span>, |
| filename: <span class="prelude-val">None</span>, |
| comment: <span class="prelude-val">None</span>, |
| operating_system: <span class="prelude-val">None</span>, |
| mtime: <span class="number">0</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Configure the `mtime` field in the gzip header. |
| </span><span class="kw">pub fn </span>mtime(<span class="kw-2">mut </span><span class="self">self</span>, mtime: u32) -> GzBuilder { |
| <span class="self">self</span>.mtime = mtime; |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Configure the `operating_system` field in the gzip header. |
| </span><span class="kw">pub fn </span>operating_system(<span class="kw-2">mut </span><span class="self">self</span>, os: u8) -> GzBuilder { |
| <span class="self">self</span>.operating_system = <span class="prelude-val">Some</span>(os); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Configure the `extra` field in the gzip header. |
| </span><span class="kw">pub fn </span>extra<T: Into<Vec<u8>>>(<span class="kw-2">mut </span><span class="self">self</span>, extra: T) -> GzBuilder { |
| <span class="self">self</span>.extra = <span class="prelude-val">Some</span>(extra.into()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Configure the `filename` field in the gzip header. |
| /// |
| /// # Panics |
| /// |
| /// Panics if the `filename` slice contains a zero. |
| </span><span class="kw">pub fn </span>filename<T: Into<Vec<u8>>>(<span class="kw-2">mut </span><span class="self">self</span>, filename: T) -> GzBuilder { |
| <span class="self">self</span>.filename = <span class="prelude-val">Some</span>(CString::new(filename.into()).unwrap()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Configure the `comment` field in the gzip header. |
| /// |
| /// # Panics |
| /// |
| /// Panics if the `comment` slice contains a zero. |
| </span><span class="kw">pub fn </span>comment<T: Into<Vec<u8>>>(<span class="kw-2">mut </span><span class="self">self</span>, comment: T) -> GzBuilder { |
| <span class="self">self</span>.comment = <span class="prelude-val">Some</span>(CString::new(comment.into()).unwrap()); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Consume this builder, creating a writer encoder in the process. |
| /// |
| /// The data written to the returned encoder will be compressed and then |
| /// written out to the supplied parameter `w`. |
| </span><span class="kw">pub fn </span>write<W: Write>(<span class="self">self</span>, w: W, lvl: Compression) -> write::GzEncoder<W> { |
| write::gz_encoder(<span class="self">self</span>.into_header(lvl), w, lvl) |
| } |
| |
| <span class="doccomment">/// Consume this builder, creating a reader encoder in the process. |
| /// |
| /// Data read from the returned encoder will be the compressed version of |
| /// the data read from the given reader. |
| </span><span class="kw">pub fn </span>read<R: Read>(<span class="self">self</span>, r: R, lvl: Compression) -> read::GzEncoder<R> { |
| read::gz_encoder(<span class="self">self</span>.buf_read(BufReader::new(r), lvl)) |
| } |
| |
| <span class="doccomment">/// Consume this builder, creating a reader encoder in the process. |
| /// |
| /// Data read from the returned encoder will be the compressed version of |
| /// the data read from the given reader. |
| </span><span class="kw">pub fn </span>buf_read<R>(<span class="self">self</span>, r: R, lvl: Compression) -> bufread::GzEncoder<R> |
| <span class="kw">where |
| </span>R: BufRead, |
| { |
| bufread::gz_encoder(<span class="self">self</span>.into_header(lvl), r, lvl) |
| } |
| |
| <span class="kw">fn </span>into_header(<span class="self">self</span>, lvl: Compression) -> Vec<u8> { |
| <span class="kw">let </span>GzBuilder { |
| extra, |
| filename, |
| comment, |
| operating_system, |
| mtime, |
| } = <span class="self">self</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>flg = <span class="number">0</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>header = <span class="macro">vec!</span>[<span class="number">0u8</span>; <span class="number">10</span>]; |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(v) = extra { |
| flg |= FEXTRA; |
| header.push((v.len() >> <span class="number">0</span>) <span class="kw">as </span>u8); |
| header.push((v.len() >> <span class="number">8</span>) <span class="kw">as </span>u8); |
| header.extend(v); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(filename) = filename { |
| flg |= FNAME; |
| header.extend(filename.as_bytes_with_nul().iter().copied()); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(comment) = comment { |
| flg |= FCOMMENT; |
| header.extend(comment.as_bytes_with_nul().iter().copied()); |
| } |
| header[<span class="number">0</span>] = <span class="number">0x1f</span>; |
| header[<span class="number">1</span>] = <span class="number">0x8b</span>; |
| header[<span class="number">2</span>] = <span class="number">8</span>; |
| header[<span class="number">3</span>] = flg; |
| header[<span class="number">4</span>] = (mtime >> <span class="number">0</span>) <span class="kw">as </span>u8; |
| header[<span class="number">5</span>] = (mtime >> <span class="number">8</span>) <span class="kw">as </span>u8; |
| header[<span class="number">6</span>] = (mtime >> <span class="number">16</span>) <span class="kw">as </span>u8; |
| header[<span class="number">7</span>] = (mtime >> <span class="number">24</span>) <span class="kw">as </span>u8; |
| header[<span class="number">8</span>] = <span class="kw">if </span>lvl.<span class="number">0 </span>>= Compression::best().<span class="number">0 </span>{ |
| <span class="number">2 |
| </span>} <span class="kw">else if </span>lvl.<span class="number">0 </span><= Compression::fast().<span class="number">0 </span>{ |
| <span class="number">4 |
| </span>} <span class="kw">else </span>{ |
| <span class="number">0 |
| </span>}; |
| |
| <span class="comment">// Typically this byte indicates what OS the gz stream was created on, |
| // but in an effort to have cross-platform reproducible streams just |
| // default this value to 255. I'm not sure that if we "correctly" set |
| // this it'd do anything anyway... |
| </span>header[<span class="number">9</span>] = operating_system.unwrap_or(<span class="number">255</span>); |
| header |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>std::io::prelude::<span class="kw-2">*</span>; |
| |
| <span class="kw">use super</span>::{read, write, GzBuilder}; |
| <span class="kw">use </span><span class="kw">crate</span>::Compression; |
| <span class="kw">use </span>rand::{thread_rng, Rng}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>roundtrip() { |
| <span class="kw">let </span><span class="kw-2">mut </span>e = write::GzEncoder::new(Vec::new(), Compression::default()); |
| e.write_all(<span class="string">b"foo bar baz"</span>).unwrap(); |
| <span class="kw">let </span>inner = e.finish().unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>d = read::GzDecoder::new(<span class="kw-2">&</span>inner[..]); |
| <span class="kw">let </span><span class="kw-2">mut </span>s = String::new(); |
| d.read_to_string(<span class="kw-2">&mut </span>s).unwrap(); |
| <span class="macro">assert_eq!</span>(s, <span class="string">"foo bar baz"</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>roundtrip_zero() { |
| <span class="kw">let </span>e = write::GzEncoder::new(Vec::new(), Compression::default()); |
| <span class="kw">let </span>inner = e.finish().unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>d = read::GzDecoder::new(<span class="kw-2">&</span>inner[..]); |
| <span class="kw">let </span><span class="kw-2">mut </span>s = String::new(); |
| d.read_to_string(<span class="kw-2">&mut </span>s).unwrap(); |
| <span class="macro">assert_eq!</span>(s, <span class="string">""</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>roundtrip_big() { |
| <span class="kw">let </span><span class="kw-2">mut </span>real = Vec::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>w = write::GzEncoder::new(Vec::new(), Compression::default()); |
| <span class="kw">let </span>v = <span class="kw">crate</span>::random_bytes().take(<span class="number">1024</span>).collect::<Vec<<span class="kw">_</span>>>(); |
| <span class="kw">for _ in </span><span class="number">0</span>..<span class="number">200 </span>{ |
| <span class="kw">let </span>to_write = <span class="kw-2">&</span>v[..thread_rng().gen_range(<span class="number">0</span>..v.len())]; |
| real.extend(to_write.iter().copied()); |
| w.write_all(to_write).unwrap(); |
| } |
| <span class="kw">let </span>result = w.finish().unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>r = read::GzDecoder::new(<span class="kw-2">&</span>result[..]); |
| <span class="kw">let </span><span class="kw-2">mut </span>v = Vec::new(); |
| r.read_to_end(<span class="kw-2">&mut </span>v).unwrap(); |
| <span class="macro">assert_eq!</span>(v, real); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>roundtrip_big2() { |
| <span class="kw">let </span>v = <span class="kw">crate</span>::random_bytes().take(<span class="number">1024 </span>* <span class="number">1024</span>).collect::<Vec<<span class="kw">_</span>>>(); |
| <span class="kw">let </span><span class="kw-2">mut </span>r = read::GzDecoder::new(read::GzEncoder::new(<span class="kw-2">&</span>v[..], Compression::default())); |
| <span class="kw">let </span><span class="kw-2">mut </span>res = Vec::new(); |
| r.read_to_end(<span class="kw-2">&mut </span>res).unwrap(); |
| <span class="macro">assert_eq!</span>(res, v); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>fields() { |
| <span class="kw">let </span>r = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">6</span>]; |
| <span class="kw">let </span>e = GzBuilder::new() |
| .filename(<span class="string">"foo.rs"</span>) |
| .comment(<span class="string">"bar"</span>) |
| .extra(<span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]) |
| .read(<span class="kw-2">&</span>r[..], Compression::default()); |
| <span class="kw">let </span><span class="kw-2">mut </span>d = read::GzDecoder::new(e); |
| <span class="macro">assert_eq!</span>(d.header().unwrap().filename(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">b"foo.rs"</span>[..])); |
| <span class="macro">assert_eq!</span>(d.header().unwrap().comment(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">b"bar"</span>[..])); |
| <span class="macro">assert_eq!</span>(d.header().unwrap().extra(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">b"\x00\x01\x02\x03"</span>[..])); |
| <span class="kw">let </span><span class="kw-2">mut </span>res = Vec::new(); |
| d.read_to_end(<span class="kw-2">&mut </span>res).unwrap(); |
| <span class="macro">assert_eq!</span>(res, <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">6</span>]); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>keep_reading_after_end() { |
| <span class="kw">let </span><span class="kw-2">mut </span>e = write::GzEncoder::new(Vec::new(), Compression::default()); |
| e.write_all(<span class="string">b"foo bar baz"</span>).unwrap(); |
| <span class="kw">let </span>inner = e.finish().unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>d = read::GzDecoder::new(<span class="kw-2">&</span>inner[..]); |
| <span class="kw">let </span><span class="kw-2">mut </span>s = String::new(); |
| d.read_to_string(<span class="kw-2">&mut </span>s).unwrap(); |
| <span class="macro">assert_eq!</span>(s, <span class="string">"foo bar baz"</span>); |
| d.read_to_string(<span class="kw-2">&mut </span>s).unwrap(); |
| <span class="macro">assert_eq!</span>(s, <span class="string">"foo bar baz"</span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>qc_reader() { |
| ::quickcheck::quickcheck(test <span class="kw">as fn</span>(<span class="kw">_</span>) -> <span class="kw">_</span>); |
| |
| <span class="kw">fn </span>test(v: Vec<u8>) -> bool { |
| <span class="kw">let </span>r = read::GzEncoder::new(<span class="kw-2">&</span>v[..], Compression::default()); |
| <span class="kw">let </span><span class="kw-2">mut </span>r = read::GzDecoder::new(r); |
| <span class="kw">let </span><span class="kw-2">mut </span>v2 = Vec::new(); |
| r.read_to_end(<span class="kw-2">&mut </span>v2).unwrap(); |
| v == v2 |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>flush_after_write() { |
| <span class="kw">let </span><span class="kw-2">mut </span>f = write::GzEncoder::new(Vec::new(), Compression::default()); |
| <span class="macro">write!</span>(f, <span class="string">"Hello world"</span>).unwrap(); |
| f.flush().unwrap(); |
| } |
| |
| <span class="kw">use </span><span class="kw">crate</span>::gz::bufread::tests::BlockingCursor; |
| <span class="attribute">#[test] |
| </span><span class="comment">// test function read_and_forget of Buffer |
| </span><span class="kw">fn </span>blocked_partial_header_read() { |
| <span class="comment">// this is a reader which receives data afterwards |
| </span><span class="kw">let </span><span class="kw-2">mut </span>r = BlockingCursor::new(); |
| <span class="kw">let </span>data = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]; |
| |
| <span class="kw">match </span>r.write_all(<span class="kw-2">&</span>data) { |
| <span class="prelude-val">Ok</span>(()) => {} |
| <span class="kw">_ </span>=> { |
| <span class="macro">panic!</span>(<span class="string">"Unexpected result for write_all"</span>); |
| } |
| } |
| r.set_position(<span class="number">0</span>); |
| |
| <span class="comment">// this is unused except for the buffering |
| </span><span class="kw">let </span><span class="kw-2">mut </span>decoder = read::GzDecoder::new(r); |
| <span class="kw">let </span><span class="kw-2">mut </span>out = Vec::with_capacity(<span class="number">7</span>); |
| <span class="kw">match </span>decoder.read(<span class="kw-2">&mut </span>out) { |
| <span class="prelude-val">Err</span>(e) => { |
| <span class="macro">assert_eq!</span>(e.kind(), std::io::ErrorKind::WouldBlock); |
| } |
| <span class="kw">_ </span>=> { |
| <span class="macro">panic!</span>(<span class="string">"Unexpected result for decoder.read"</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> |
