hasufell/pnmixer-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ba37edf785
pnmixer-rust/inflate/index.html
Julian Ospald ba37edf785
Update and fix
2017-07-15 01:30:16 +02:00

196 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="API documentation for the Rust `inflate` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, inflate">
<title>inflate - Rust</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 mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Crate inflate</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'inflate', ty: 'mod', relpath: '../'};</script>
</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">
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>inflate</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/inflate/lib.rs.html#10-1066' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A <a href="http://www.gzip.org/zlib/rfc-deflate.html">DEFLATE</a> decoder written in rust.</p>
<p>This library provides functionality to decompress data compressed with the DEFLATE algorithm,
both with and without a <a href="https://tools.ietf.org/html/rfc1950">zlib</a> header/trailer.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<p>The easiest way to get <code>std::Vec&lt;u8&gt;</code> containing the decompressed bytes is to use either
<code>inflate::inflate_bytes</code> or <code>inflate::inflate_bytes_zlib</code> (depending on whether
the encoded data has zlib headers and trailers or not). The following example
decodes the DEFLATE encoded string &quot;Hello, world&quot; and prints it:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">inflate</span>::<span class="ident">inflate_bytes</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">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">40</span>, <span class="number">207</span>, <span class="number">47</span>, <span class="number">202</span>, <span class="number">73</span>, <span class="number">1</span>, <span class="number">0</span>];
<span class="kw">let</span> <span class="ident">decoded</span> <span class="op">=</span> <span class="ident">inflate_bytes</span>(<span class="kw-2">&amp;</span><span class="ident">encoded</span>).<span class="ident">unwrap</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">from_utf8</span>(<span class="kw-2">&amp;</span><span class="ident">decoded</span>).<span class="ident">unwrap</span>()); <span class="comment">// prints &quot;Hello, world&quot;</span></pre>
<p>If you need more flexibility, then the library also provides an implementation
of <code>std::io::Writer</code> in <code>inflate::writer</code>. Below is an example using an
<code>inflate::writer::InflateWriter</code> to decode the DEFLATE encoded string &quot;Hello, world&quot;:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">inflate</span>::<span class="ident">InflateWriter</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">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">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">40</span>, <span class="number">207</span>, <span class="number">47</span>, <span class="number">202</span>, <span class="number">73</span>, <span class="number">1</span>, <span class="number">0</span>];
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">decoder</span> <span class="op">=</span> <span class="ident">InflateWriter</span>::<span class="ident">new</span>(<span class="ident">Vec</span>::<span class="ident">new</span>());
<span class="ident">decoder</span>.<span class="ident">write</span>(<span class="kw-2">&amp;</span><span class="ident">encoded</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">decoded</span> <span class="op">=</span> <span class="ident">decoder</span>.<span class="ident">finish</span>().<span class="ident">unwrap</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">from_utf8</span>(<span class="kw-2">&amp;</span><span class="ident">decoded</span>).<span class="ident">unwrap</span>()); <span class="comment">// prints &quot;Hello, world&quot;</span></pre>
<p>Finally, if you need even more flexibility, or if you only want to depend on
<code>core</code>, you can use the <code>inflate::InflateStream</code> API. The below example
decodes an array of DEFLATE encoded bytes:</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">inflate</span>::<span class="ident">InflateStream</span>;
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> [<span class="number">0x73</span>, <span class="number">0x49</span>, <span class="number">0x4d</span>, <span class="number">0xcb</span>, <span class="number">0x49</span>, <span class="number">0x2c</span>, <span class="number">0x49</span>, <span class="number">0x55</span>, <span class="number">0x00</span>, <span class="number">0x11</span>, <span class="number">0x00</span>];
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">inflater</span> <span class="op">=</span> <span class="ident">InflateStream</span>::<span class="ident">new</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">out</span> <span class="op">=</span> <span class="ident">Vec</span>::<span class="op">&lt;</span><span class="ident">u8</span><span class="op">&gt;</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">&lt;</span> <span class="ident">data</span>.<span class="ident">len</span>() {
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">inflater</span>.<span class="ident">update</span>(<span class="kw-2">&amp;</span><span class="ident">data</span>[<span class="ident">n</span>..]);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>((<span class="ident">num_bytes_read</span>, <span class="ident">result</span>)) <span class="op">=</span> <span class="ident">res</span> {
<span class="ident">n</span> <span class="op">+=</span> <span class="ident">num_bytes_read</span>;
<span class="ident">out</span>.<span class="ident">extend</span>(<span class="ident">result</span>.<span class="ident">iter</span>().<span class="ident">cloned</span>());
} <span class="kw">else</span> {
<span class="ident">res</span>.<span class="ident">unwrap</span>();
}
}</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.InflateStream.html"
title='struct inflate::InflateStream'>InflateStream</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.InflateWriter.html"
title='struct inflate::InflateWriter'>InflateWriter</a></td>
<td class='docblock-short'>
<p>A DEFLATE decoder.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.inflate_bytes.html"
title='fn inflate::inflate_bytes'>inflate_bytes</a></td>
<td class='docblock-short'>
<p>Decompress the given slice of DEFLATE compressed data.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.inflate_bytes_zlib.html"
title='fn inflate::inflate_bytes_zlib'>inflate_bytes_zlib</a></td>
<td class='docblock-short'>
<p>Decompress the given slice of DEFLATE compressed (with zlib headers and trailers) data.</p>
</td>
</tr></table></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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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>
Reference in New Issue View Git Blame Copy Permalink