<html><head><metacharset="UTF-8"><linkhref="css/default.css"rel="stylesheet"type="text/css"><scriptsrc="js/jquery.min.js"type="text/javascript"></script><scriptsrc="js/page_effects.js"type="text/javascript"></script><title>taoensso.nippy.compression documentation</title></head><body><divid="header"><h2>Generated by <ahref="https://github.com/weavejester/codox">Codox</a></h2><h1><ahref="index.html">Nippy 2.7.0-alpha1 API documentation</a></h1></div><divclass="sidebar"id="namespaces"><h3><ahref="index.html"><spanclass="inner">Namespaces</span></a></h3><ul><liclass="depth-1"><divclass="no-link"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>taoensso</span></div></div></li><liclass="depth-2"><ahref="taoensso.nippy.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>nippy</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.benchmarks.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>benchmarks</span></div></a></li><liclass="depth-3 branch current"><ahref="taoensso.nippy.compression.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>compression</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.encryption.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>encryption</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.tools.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>tools</span></div></a></li><liclass="depth-3"><ahref="taoensso.nippy.utils.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>utils</span></div></a></li></ul></div><divclass="sidebar"id="vars"><h3><ahref="#top"><spanclass="inner">Public Vars</span></a></h3><ul><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var--.3ELZ4Compressor"><divclass="inner"><span>->LZ4Compressor</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var--.3ELZMA2Compressor"><divclass="inner"><span>->LZMA2Compressor</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var--.3ESnappyCompressor"><divclass="inner"><span>->SnappyCompressor</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var-ICompressor"><divclass="inner"><span>ICompressor</span></div></a></li><liclass="depth-2 branch"><ahref="taoensso.nippy.compression.html#var-compress"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>compress</span></div></a></li><liclass="depth-2 branch"><ahref="taoensso.nippy.compression.html#var-decompress"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>decompress</span></div></a></li><liclass="depth-2"><ahref="taoensso.nippy.compression.html#var-header-id"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>header-id</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var-lz4-compressor"><divclass="inner"><span>lz4-compressor</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var-lz4hc-compressor"><divclass="inner"><span>lz4hc-compressor</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var-lzma2-compressor"><divclass="inner"><span>lzma2-compressor</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var-snappy-compressor"><divclass="inner"><span>snappy-compressor</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.compression.html#var-standard-header-ids"><divclass="inner"><span>standard-header-ids</span></div></a></li></ul></div><divclass="namespace-docs"id="content"><h2class="anchor"id
</pre></div></div><divclass="public anchor"id="var--.3ELZMA2Compressor"><h3>->LZMA2Compressor</h3><divclass="usage"><code>(->LZMA2Compressor compression-level)</code></div><divclass="doc"><preclass="plaintext">Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
</pre></div></div><divclass="public anchor"id="var--.3ESnappyCompressor"><h3>->SnappyCompressor</h3><divclass="usage"><code>(->SnappyCompressor)</code></div><divclass="doc"><preclass="plaintext">Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
A good general-purpose compressor, competitive with Snappy.
Thanks to Max Penet (@mpenet) for our first implementation,
Ref. <ahref="https://github.com/mpenet/nippy-lz4">https://github.com/mpenet/nippy-lz4</a></pre></div></div><divclass="public anchor"id="var-lz4hc-compressor"><h3>lz4hc-compressor</h3><divclass="usage"></div><divclass="doc"><preclass="plaintext">Like `lz4-compressor` but trades some write speed for ratio.
A good general-purpose compressor.</pre></div></div><divclass="public anchor"id="var-standard-header-ids"><h3>standard-header-ids</h3><divclass="usage"></div><divclass="doc"><preclass="plaintext">These'll support :auto thaw.
