<html><head><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 documentation</title></head><body><divid="header"><h2>Generated by <ahref="https://github.com/weavejester/codox">Codox</a></h2><h1><ahref="index.html">Nippy 2.0.0-alpha5 API documentation</a></h1></div><divclass="sidebar"id="namespaces"><h3><span>Namespaces</span></h3><ul><liclass="current"><ahref="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><ahref="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><ahref="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li><ahref="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><li><ahref="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><divclass="sidebar"id="vars"><h3>Public Vars</h3><ul><li><ahref="taoensso.nippy.html#var-coll-thaw"><span>coll-thaw</span></a></li><li><ahref="taoensso.nippy.html#var-coll-thaw-kvs"><span>coll-thaw-kvs</span></a></li><li><ahref="taoensso.nippy.html#var-freeze"><span>freeze</span></a></li><li><ahref="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><ahref="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><ahref="taoensso.nippy.html#var-thaw"><span>thaw</span></a></li><li><ahref="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li></ul></div><divclass="namespace-docs"id="content"><h2>taoensso.nippy documentation</h2><preclass="doc">Simple, high-performance Clojure serialization library. Originally adapted
</pre></div><divclass="public"id="var-freeze"><h3>freeze</h3><divclass="usage"><code>(freeze x & [{:keys [print-dup? password compressor encryptor legacy-mode], :or {print-dup? true, compressor compression/default-snappy-compressor, encryptor encryption/default-aes128-encryptor}}])</code></div><preclass="doc">Serializes arg (any Clojure data type) to a byte array. Set :legacy-mode to
true to produce bytes readble by Nippy < 2.x.</pre></div><divclass="public"id="var-freeze-to-bytes"><h3>freeze-to-bytes</h3><divclass="usage"><code>(freeze-to-bytes x & {:keys [print-dup? compress? password], :or {print-dup? true, compress? true}})</code></div><preclass="doc">DEPRECATED: Use `freeze` instead.
</pre></div><divclass="public"id="var-stress-data"><h3>stress-data</h3><divclass="usage"></div><preclass="doc">Reference data used for tests & benchmarks.
</pre></div><divclass="public"id="var-thaw"><h3>thaw</h3><divclass="usage"><code>(thaw ba & [{:keys [read-eval? password compressor encryptor legacy-mode strict?], :or {legacy-mode :auto, compressor compression/default-snappy-compressor, encryptor encryption/default-aes128-encryptor}}])</code></div><preclass="doc">Deserializes frozen bytes to their original Clojure data type.
:legacy-mode options:
false - Nippy >= 2.x data only (best).
true - Nippy < 2.x data only (deprecated).
:auto - Mixed data (default, migrating).
In most cases you'll want :auto if you're using a preexisting data set, and
WARNING: Enabling `:read-eval?` can lead to security vulnerabilities unless
you are sure you know what you're doing.</pre></div><divclass="public"id="var-thaw-from-bytes"><h3>thaw-from-bytes</h3><divclass="usage"><code>(thaw-from-bytes ba & {:keys [read-eval? compressed? password], :or {compressed? true}})</code></div><preclass="doc">DEPRECATED: Use `thaw` instead.
