|
|
<!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 `lzw` crate."><meta name="keywords" content="rust, rustlang, rust-lang, lzw"><title>lzw - Rust</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 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"><div class="sidebar-menu">☰</div><a href='../lzw/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate lzw</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all lzw's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'lzw', ty: 'mod', relpath: '../'};</script></div></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"><h1 class='fqn'><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'>−</span>]</a></span><a class='srclink' href='../src/lzw/lib.rs.html#1-43' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>lzw</a></span></h1><div class='docblock'><h1 id="lzw-decoder-and-encoder" class="section-header"><a href="#lzw-decoder-and-encoder">LZW decoder and encoder</a></h1>
|
|
|
<p>This crates provides a <code>LzwEncoder</code> and <code>LzwDecoder</code>. The code words are written from
|
|
|
and to bit streams where it is possible to write either the most or least significant
|
|
|
bit first. The maximum possible code size is 16 bits. Both types rely on RAII to
|
|
|
produced correct results.</p>
|
|
|
<p>The de- and encoder expect the LZW stream to start with a clear code and end with an
|
|
|
end code which are defined as follows:</p>
|
|
|
<ul>
|
|
|
<li><code>CLEAR_CODE == 1 << min_code_size</code></li>
|
|
|
<li><code>END_CODE == CLEAR_CODE + 1</code></li>
|
|
|
</ul>
|
|
|
<p>Examplary use of the encoder:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">lzw</span>::{<span class="ident">LsbWriter</span>, <span class="ident">Encoder</span>};
|
|
|
<span class="kw">let</span> <span class="ident">size</span> <span class="op">=</span> <span class="number">8</span>;
|
|
|
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"TOBEORNOTTOBEORTOBEORNOT"</span>;
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">compressed</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
|
|
{
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">enc</span> <span class="op">=</span> <span class="ident">Encoder</span>::<span class="ident">new</span>(<span class="ident">LsbWriter</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">size</span>).<span class="ident">unwrap</span>();
|
|
|
<span class="ident">enc</span>.<span class="ident">encode_bytes</span>(<span class="ident">data</span>).<span class="ident">unwrap</span>();
|
|
|
}</pre></div>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Decoder.html" title='lzw::Decoder struct'>Decoder</a></td><td class='docblock-short'><p>Decoder for a LZW compressed stream (this algorithm is used for GIF files).</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DecoderEarlyChange.html" title='lzw::DecoderEarlyChange struct'>DecoderEarlyChange</a></td><td class='docblock-short'><p>Decoder for a LZW compressed stream using an “early change” algorithm (used in TIFF files).</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Encoder.html" title='lzw::Encoder struct'>Encoder</a></td><td class='docblock-short'><p>LZW encoder using the algorithm of GIF files.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LsbReader.html" title='lzw::LsbReader struct'>LsbReader</a></td><td class='docblock-short'><p>Reads bits from a byte stream, LSB first.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LsbWriter.html" title='lzw::LsbWriter struct'>LsbWriter</a></td><td class='docblock-short'><p>Writes bits to a byte stream, LSB first.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MsbReader.html" title='lzw::MsbReader struct'>MsbReader</a></td><td class='docblock-short'><p>Reads bits from a byte stream, MSB first.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MsbWriter.html" title='lzw::MsbWriter struct'>MsbWriter</a></td><td class='docblock-short'><p>Writes bits to a byte stream, MSB first.</p>
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.Bits.html" title='lzw::Bits enum'>Bits</a></td><td class='docblock-short'><p>Containes either the consumed bytes and reconstructed bits or
|
|
|
only the consumed bytes if the supplied buffer was not bit enough</p>
|
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.BitReader.html" title='lzw::BitReader trait'>BitReader</a></td><td class='docblock-short'><p>A bit reader.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.BitWriter.html" title='lzw::BitWriter trait'>BitWriter</a></td><td class='docblock-short'><p>A bit writer.</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.encode.html" title='lzw::encode fn'>encode</a></td><td class='docblock-short'><p>Convenience function that reads and compresses all bytes from <code>R</code>.</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><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 = "lzw";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
