<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 1.3.0-alpha2 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.crypto.html"><span>taoensso.nippy.crypto</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-freezer"><span>coll-freezer</span></a></li><li><ahref="taoensso.nippy.html#var-coll-thaw%21"><span>coll-thaw!</span></a></li><li><ahref="taoensso.nippy.html#var-coll-thaw-kvs%21"><span>coll-thaw-kvs!</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-freeze-to-stream%21"><span>freeze-to-stream!</span></a></li><li><ahref="taoensso.nippy.html#var-freezer"><span>freezer</span></a></li><li><ahref="taoensso.nippy.html#var-kv-freezer"><span>kv-freezer</span></a></li><li><ahref="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><ahref="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li><li><ahref="taoensso.nippy.html#var-thaw-from-stream%21"><span>thaw-from-stream!</span></a></li></ul></div><divclass="namespace-docs"id="content"><h2>taoensso.nippy documentation</h2><preclass="doc">Simple, high-performance Clojure serialization library. Adapted from
Deep-Freeze.</pre><divclass="public"id="var-coll-freezer"><h3>coll-freezer</h3><h4class="macro">macro</h4><divclass="usage"><code>(coll-freezer type id & body)</code></div><preclass="doc">Extends Freezable to simple collection types.
</pre></div><divclass="public"id="var-freeze-to-bytes"><h3>freeze-to-bytes</h3><divclass="usage"><code>(freeze-to-bytes x & {:keys [compress? print-dup? password], :or {compress? true, print-dup? true}})</code></div><preclass="doc">Serializes x to a byte array and returns the array.
</pre></div><divclass="public"id="var-freeze-to-stream%21"><h3>freeze-to-stream!</h3><divclass="usage"><code>(freeze-to-stream! data-output-stream x)</code><code>(freeze-to-stream! data-output-stream x print-dup?)</code></div><preclass="doc">Serializes x to given output stream.
</pre></div><divclass="public"id="var-freezer"><h3>freezer</h3><h4class="macro">macro</h4><divclass="usage"><code>(freezer type id & body)</code></div><preclass="doc">Helper to extend Freezable protocol.
</pre></div><divclass="public"id="var-kv-freezer"><h3>kv-freezer</h3><h4class="macro">macro</h4><divclass="usage"><code>(kv-freezer type id & body)</code></div><preclass="doc">Extends Freezable to key-value collection types.
</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-from-bytes"><h3>thaw-from-bytes</h3><divclass="usage"><code>(thaw-from-bytes ba & {:keys [compressed? read-eval? password], :or {compressed? true, read-eval? false}})</code></div><preclass="doc">Deserializes an object from given byte array.
</pre></div><divclass="public"id="var-thaw-from-stream%21"><h3>thaw-from-stream!</h3><divclass="usage"><code>(thaw-from-stream! data-input-stream read-eval?)</code></div><preclass="doc">Deserializes an object from given input stream.
