<!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 `/home/sangenya/.cargo/registry/src/github.com-1ecc6299db9ec823/lzw-0.10.0/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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"><div class="sidebar-menu" role="button">☰</div><a href='../../lzw/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><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>
</pre><pre class="rust">
<span class="doccomment">//! # LZW decoder and encoder</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This crates provides a `LzwEncoder` and `LzwDecoder`. The code words are written from</span>
<span class="doccomment">//! and to bit streams where it is possible to write either the most or least significant </span>
<span class="doccomment">//! bit first. The maximum possible code size is 16 bits. Both types rely on RAII to</span>
<span class="doccomment">//! produced correct results.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The de- and encoder expect the LZW stream to start with a clear code and end with an</span>
<span class="doccomment">//! end code which are defined as follows:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! * `CLEAR_CODE == 1 << min_code_size`</span>
<span class="doccomment">//! * `END_CODE == CLEAR_CODE + 1`</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Examplary use of the encoder:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! use lzw::{LsbWriter, Encoder};</span>
<span class="doccomment">//! let size = 8;</span>
<span class="doccomment">//! let data = b"TOBEORNOTTOBEORTOBEORNOT";</span>
<span class="doccomment">//! let mut compressed = vec![];</span>
<span class="doccomment">//! {</span>
<span class="doccomment">//! let mut enc = Encoder::new(LsbWriter::new(&mut compressed), size).unwrap();</span>
<span class="doccomment">//! enc.encode_bytes(data).unwrap();</span>
<span class="doccomment">//! }</span>
<span class="kw">mod</span> <span class="ident">lzw</span>;
<span class="kw">mod</span> <span class="ident">bitstream</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">lzw</span>::{
<span class="ident">Decoder</span>,
<span class="ident">DecoderEarlyChange</span>,
<span class="ident">Encoder</span>,
<span class="ident">encode</span>
};
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">bitstream</span>::{
<span class="ident">BitReader</span>,
<span class="ident">BitWriter</span>,
<span class="ident">LsbReader</span>,
<span class="ident">LsbWriter</span>,
<span class="ident">MsbReader</span>,
<span class="ident">MsbWriter</span>,
<span class="ident">Bits</span>
};</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="lzw" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>