| <!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/snap-0.2.5/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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="../../snap/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="../../snap/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> |
| </pre><pre class="rust"><code><span class="doccomment">/*! |
| This crate provides an implementation of the |
| [Snappy compression format](https://github.com/google/snappy/blob/master/format_description.txt), |
| as well as the |
| [framing format](https://github.com/google/snappy/blob/master/framing_format.txt). |
| The goal of Snappy is to provide reasonable compression at high speed. On a |
| modern CPU, Snappy can compress data at about 300 MB/sec or more and can |
| decompress data at about 800 MB/sec or more. |
| |
| # Install |
| |
| To use this crate with |
| [Cargo](http://doc.crates.io/index.html), |
| simply add it as a dependency to your `Cargo.toml`: |
| |
| ```ignore |
| [dependencies] |
| snap = "0.2" |
| ``` |
| |
| and add `extern crate snap;` to your crate root. |
| |
| # Overview |
| |
| This crate provides two ways to use Snappy. The first way is through the |
| `Reader` and `Writer` types, which implement the `std::io::Read` and |
| `std::io::Write` traits with the Snappy frame format. Unless you have a |
| specific reason to the contrary, you should only need to use these types. |
| Specifically, the Snappy frame format permits streaming compression or |
| decompression. |
| |
| The second way is through the `Decoder` and `Encoder` types. These types |
| provide lower level control to the raw Snappy format, and don't support a |
| streaming interface directly. You should only use these types if you know you |
| specifically need the Snappy raw format. |
| |
| Finally, the `Error` type in this crate provides an exhaustive list of error |
| conditions that are probably useless in most circumstances. Therefore, |
| `From<snap::Error> for io::Error` is implemented in this crate, which will let |
| you automatically convert a Snappy error to an `std::io::Error` (when using |
| `try!`) with an appropriate error message to display to an end user. |
| |
| # Example: compress data on `stdin` |
| |
| This program reads data from `stdin`, compresses it and emits it to `stdout`. |
| This example can be found in `examples/compress.rs`: |
| |
| ```rust,ignore |
| extern crate snap; |
| |
| use std::io; |
| |
| fn main() { |
| let stdin = io::stdin(); |
| let stdout = io::stdout(); |
| |
| let mut rdr = stdin.lock(); |
| // Wrap the stdout writer in a Snappy writer. |
| let mut wtr = snap::Writer::new(stdout.lock()); |
| io::copy(&mut rdr, &mut wtr).expect("I/O operation failed"); |
| } |
| ``` |
| |
| # Example: decompress data on `stdin` |
| |
| This program reads data from `stdin`, decompresses it and emits it to `stdout`. |
| This example can be found in `examples/decompress.rs`: |
| |
| ```rust,ignore |
| extern crate snap; |
| |
| use std::io; |
| |
| fn main() { |
| let stdin = io::stdin(); |
| let stdout = io::stdout(); |
| |
| // Wrap the stdin reader in a Snappy reader. |
| let mut rdr = snap::Reader::new(stdin.lock()); |
| let mut wtr = stdout.lock(); |
| io::copy(&mut rdr, &mut wtr).expect("I/O operation failed"); |
| } |
| ``` |
| */ |
| |
| </span><span class="attribute">#![deny(missing_docs)] |
| |
| </span><span class="kw">extern crate </span>byteorder; |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">extern crate </span>lazy_static; |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">extern crate </span>quickcheck; |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">extern crate </span>rand; |
| <span class="attribute">#[cfg(all(test, feature = <span class="string">"cpp"</span>))] |
| </span><span class="kw">extern crate </span>snappy_cpp; |
| |
| <span class="kw">pub use </span>compress::{Encoder, max_compress_len}; |
| <span class="kw">pub use </span>decompress::{Decoder, decompress_len}; |
| <span class="kw">pub use </span>error::{Error, IntoInnerError, <span class="prelude-ty">Result</span>}; |
| <span class="kw">pub use </span>frame::{Reader, Writer}; |
| |
| <span class="doccomment">/// We don't permit compressing a block bigger than what can fit in a u32. |
| </span><span class="kw">const </span>MAX_INPUT_SIZE: u64 = ::std::u32::MAX <span class="kw">as </span>u64; |
| |
| <span class="doccomment">/// The maximum number of bytes that we process at once. A block is the unit |
| /// at which we scan for candidates for compression. |
| </span><span class="kw">const </span>MAX_BLOCK_SIZE: usize = <span class="number">1</span><<<span class="number">16</span>; |
| |
| <span class="kw">mod </span>compress; |
| <span class="kw">mod </span>crc32; |
| <span class="kw">mod </span>decompress; |
| <span class="kw">mod </span>error; |
| <span class="kw">mod </span>frame; |
| <span class="kw">mod </span>tag; |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests; |
| <span class="kw">mod </span>varint; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="snap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
