nippy/taoensso.nippy.html

11 lines
3.3 KiB
HTML
Raw Normal View History

2013-06-01 12:16:45 +00:00
<!DOCTYPE html>
2013-06-25 07:50:36 +00:00
<html><head><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 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.0.0-RC1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li class="current"><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li><a href="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><li><a href="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.html#var-freeze"><span>freeze</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><a href="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><a href="taoensso.nippy.html#var-thaw"><span>thaw</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy documentation</h2><pre class="doc">Simple, high-performance Clojure serialization library. Originally adapted
2013-06-16 12:36:29 +00:00
from Deep-Freeze.</pre><div class="public" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x &amp; [{:keys [print-dup? password compressor encryptor legacy-mode], :or {print-dup? true, compressor snappy-compressor, encryptor aes128-encryptor}}])</code></div><pre class="doc">Serializes arg (any Clojure data type) to a byte array. Set :legacy-mode to
true to produce bytes readble by Nippy &lt; 2.x.</pre></div><div class="public" id="var-freeze-to-bytes"><h3>freeze-to-bytes</h3><div class="usage"><code>(freeze-to-bytes x &amp; {:keys [print-dup? compress?], :or {print-dup? true, compress? true}})</code></div><pre class="doc">DEPRECATED: Use `freeze` instead.
2013-06-01 12:16:45 +00:00
</pre></div><div class="public" id="var-stress-data"><h3>stress-data</h3><div class="usage"></div><pre class="doc">Reference data used for tests &amp; benchmarks.
2013-06-25 07:50:36 +00:00
</pre></div><div class="public" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba &amp; [{:keys [read-eval? password compressor encryptor legacy-opts], :or {legacy-opts {:compressed? true}, compressor snappy-compressor, encryptor aes128-encryptor}, :as opts}])</code></div><pre class="doc">Deserializes frozen bytes to their original Clojure data type. Supports data
2013-06-16 12:36:29 +00:00
frozen with current and all previous versions of Nippy.
2013-06-13 09:49:09 +00:00
WARNING: Enabling `:read-eval?` can lead to security vulnerabilities unless
2013-06-16 12:36:29 +00:00
you are sure you know what you're doing.</pre></div><div class="public" id="var-thaw-from-bytes"><h3>thaw-from-bytes</h3><div class="usage"><code>(thaw-from-bytes ba &amp; {:keys [read-eval? compressed?], :or {compressed? true}})</code></div><pre class="doc">DEPRECATED: Use `thaw` instead.
2013-06-01 12:16:45 +00:00
</pre></div></div></body></html>