26 lines
No EOL
7.3 KiB
HTML
26 lines
No EOL
7.3 KiB
HTML
<!DOCTYPE html>
|
|
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.compression documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 2.9.0-beta2 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.nippy.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>nippy</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.benchmarks.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>benchmarks</span></div></a></li><li class="depth-3 branch current"><a href="taoensso.nippy.compression.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>compression</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.encryption.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>encryption</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.tools.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools</span></div></a></li><li class="depth-3"><a href="taoensso.nippy.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ELZ4Compressor"><div class="inner"><span>->LZ4Compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ELZMA2Compressor"><div class="inner"><span>->LZMA2Compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ESnappyCompressor"><div class="inner"><span>->SnappyCompressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-ICompressor"><div class="inner"><span>ICompressor</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.compression.html#var-compress"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>compress</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.compression.html#var-decompress"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>decompress</span></div></a></li><li class="depth-2"><a href="taoensso.nippy.compression.html#var-header-id"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>header-id</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lz4-compressor"><div class="inner"><span>lz4-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lz4hc-compressor"><div class="inner"><span>lz4hc-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lzma2-compressor"><div class="inner"><span>lzma2-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-snappy-compressor"><div class="inner"><span>snappy-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-standard-header-ids"><div class="inner"><span>standard-header-ids</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">taoensso.nippy.compression</h2><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var--.3ELZ4Compressor"><h3>->LZ4Compressor</h3><div class="usage"><code>(->LZ4Compressor compressor decompressor)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
|
|
</pre></div></div><div class="public anchor" id="var--.3ELZMA2Compressor"><h3>->LZMA2Compressor</h3><div class="usage"><code>(->LZMA2Compressor compression-level)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
|
|
</pre></div></div><div class="public anchor" id="var--.3ESnappyCompressor"><h3>->SnappyCompressor</h3><div class="usage"><code>(->SnappyCompressor)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
|
|
</pre></div></div><div class="public anchor" id="var-ICompressor"><h3>ICompressor</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-compress"><h3>compress</h3><div class="usage"><code>(compress compressor ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-decompress"><h3>decompress</h3><div class="usage"><code>(decompress compressor ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-header-id"><h3>header-id</h3><div class="usage"><code>(header-id compressor)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div></div><div class="public anchor" id="var-lz4-compressor"><h3>lz4-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default net.jpountz.lz4 compressor:
|
|
Ratio: low.
|
|
Write speed: very high.
|
|
Read speed: very high.
|
|
|
|
A good general-purpose compressor, competitive with Snappy.
|
|
|
|
Thanks to Max Penet (@mpenet) for our first implementation,
|
|
Ref. <a href="https://github.com/mpenet/nippy-lz4">https://github.com/mpenet/nippy-lz4</a></pre></div></div><div class="public anchor" id="var-lz4hc-compressor"><h3>lz4hc-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Like `lz4-compressor` but trades some write speed for ratio.
|
|
</pre></div></div><div class="public anchor" id="var-lzma2-compressor"><h3>lzma2-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default org.tukaani.xz.LZMA2 compressor:
|
|
Ratio: high.
|
|
Write speed: _very_ slow (also currently single-threaded).
|
|
Read speed: slow.
|
|
|
|
A specialized compressor for large, low-write data in space-sensitive
|
|
environments.</pre></div></div><div class="public anchor" id="var-snappy-compressor"><h3>snappy-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default org.iq80.snappy.Snappy compressor:
|
|
Ratio: low.
|
|
Write speed: very high.
|
|
Read speed: very high.
|
|
|
|
A good general-purpose compressor.</pre></div></div><div class="public anchor" id="var-standard-header-ids"><h3>standard-header-ids</h3><div class="usage"></div><div class="doc"><pre class="plaintext">These'll support :auto thaw.
|
|
</pre></div></div></div></body></html> |