<!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/jule/.cargo/registry/src/github.com-1ecc6299db9ec823/inflate-0.2.0/src/utils.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>utils.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</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">
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</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>
</pre><pre class="rust ">
<span class="doccomment">/// Convenience functions for inflating DEFLATE compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use inflate::inflate_bytes;</span>
<span class="doccomment">/// use std::str::from_utf8;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let encoded = [243, 72, 205, 201, 201, 215, 81, 40, 207, 47, 202, 73, 1, 0];</span>
<span class="doccomment">/// let decoded = inflate_bytes(&encoded).unwrap();</span>
<span class="doccomment">/// println!("{}", from_utf8(&decoded).unwrap()); // prints "Hello, world"</span>
<span class="doccomment">/// ```</span>
<span class="kw">use</span> <span class="ident">InflateStream</span>;
<span class="kw">fn</span> <span class="ident">inflate</span>(<span class="ident">inflater</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">InflateStream</span>, <span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-></span> <span class="prelude-ty">Result</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">String</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">decoded</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">new</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">n</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">while</span> <span class="ident">n</span> <span class="op"><</span> <span class="ident">data</span>.<span class="ident">len</span>() {
<span class="kw">let</span> (<span class="ident">num_bytes_read</span>, <span class="ident">bytes</span>) <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">inflater</span>.<span class="ident">update</span>(<span class="kw-2">&</span><span class="ident">data</span>[<span class="ident">n</span>..]));
<span class="ident">n</span> <span class="op">+=</span> <span class="ident">num_bytes_read</span>;
<span class="ident">decoded</span>.<span class="ident">extend</span>(<span class="ident">bytes</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> <span class="kw-2">*</span><span class="ident">v</span>));
}
<span class="prelude-val">Ok</span>(<span class="ident">decoded</span>)
}
<span class="doccomment">/// Decompress the given slice of DEFLATE compressed data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a `Vec` with the decompressed data or an error message.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">inflate_bytes</span>(<span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-></span> <span class="prelude-ty">Result</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">String</span><span class="op">></span> {
<span class="ident">inflate</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">InflateStream</span>::<span class="ident">new</span>(), <span class="ident">data</span>)
}
<span class="doccomment">/// Decompress the given slice of DEFLATE compressed (with zlib headers and trailers) data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns a `Vec` with the decompressed data or an error message.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">inflate_bytes_zlib</span>(<span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-></span> <span class="prelude-ty">Result</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">String</span><span class="op">></span> {
<span class="ident">inflate</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">InflateStream</span>::<span class="ident">from_zlib</span>(), <span class="ident">data</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="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">inflate_bytes_with_zlib</span>() {
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">inflate_bytes_zlib</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">from_utf8</span>;
<span class="kw">let</span> <span class="ident">encoded</span> <span class="op">=</span> [<span class="number">120</span>, <span class="number">156</span>, <span class="number">243</span>, <span class="number">72</span>, <span class="number">205</span>, <span class="number">201</span>, <span class="number">201</span>, <span class="number">215</span>, <span class="number">81</span>, <span class="number">168</span>, <span class="number">202</span>, <span class="number">201</span>, <span class="number">76</span>, <span class="number">82</span>, <span class="number">4</span>, <span class="number">0</span>, <span class="number">27</span>, <span class="number">101</span>, <span class="number">4</span>, <span class="number">19</span>];
<span class="kw">let</span> <span class="ident">decoded</span> <span class="op">=</span> <span class="ident">inflate_bytes_zlib</span>(<span class="kw-2">&</span><span class="ident">encoded</span>).<span class="ident">unwrap</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">from_utf8</span>(<span class="kw-2">&</span><span class="ident">decoded</span>).<span class="ident">unwrap</span>() <span class="op">==</span> <span class="string">"Hello, zlib!"</span>);
}
}
</pre>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "inflate";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>