25 lines
No EOL
14 KiB
HTML
25 lines
No EOL
14 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 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.5.0 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--%3ECompressable-LZMA2"><span>->Compressable-LZMA2</span></a></li><li><a href="taoensso.nippy.html#var--%3EStressRecord"><span>->StressRecord</span></a></li><li><a href="taoensso.nippy.html#var-Freezable"><span>Freezable</span></a></li><li><a href="taoensso.nippy.html#var-custom-readers"><span>custom-readers</span></a></li><li><a href="taoensso.nippy.html#var-extend-freeze"><span>extend-freeze</span></a></li><li><a href="taoensso.nippy.html#var-extend-thaw"><span>extend-thaw</span></a></li><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-freeze-to-stream%21"><span>freeze-to-stream!</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-stream*"><span>freeze-to-stream*</span></a></li><li><a href="taoensso.nippy.html#var-id-bigdec"><span>id-bigdec</span></a></li><li><a href="taoensso.nippy.html#var-id-bigint"><span>id-bigint</span></a></li><li><a href="taoensso.nippy.html#var-id-boolean"><span>id-boolean</span></a></li><li><a href="taoensso.nippy.html#var-id-byte"><span>id-byte</span></a></li><li><a href="taoensso.nippy.html#var-id-bytes"><span>id-bytes</span></a></li><li><a href="taoensso.nippy.html#var-id-char"><span>id-char</span></a></li><li><a href="taoensso.nippy.html#var-id-date"><span>id-date</span></a></li><li><a href="taoensso.nippy.html#var-id-double"><span>id-double</span></a></li><li><a href="taoensso.nippy.html#var-id-float"><span>id-float</span></a></li><li><a href="taoensso.nippy.html#var-id-integer"><span>id-integer</span></a></li><li><a href="taoensso.nippy.html#var-id-keyword"><span>id-keyword</span></a></li><li><a href="taoensso.nippy.html#var-id-list"><span>id-list</span></a></li><li><a href="taoensso.nippy.html#var-id-long"><span>id-long</span></a></li><li><a href="taoensso.nippy.html#var-id-map"><span>id-map</span></a></li><li><a href="taoensso.nippy.html#var-id-meta"><span>id-meta</span></a></li><li><a href="taoensso.nippy.html#var-id-nil"><span>id-nil</span></a></li><li><a href="taoensso.nippy.html#var-id-old-keyword"><span>id-old-keyword</span></a></li><li><a href="taoensso.nippy.html#var-id-old-map"><span>id-old-map</span></a></li><li><a href="taoensso.nippy.html#var-id-old-reader"><span>id-old-reader</span></a></li><li><a href="taoensso.nippy.html#var-id-old-string"><span>id-old-string</span></a></li><li><a href="taoensso.nippy.html#var-id-queue"><span>id-queue</span></a></li><li><a href="taoensso.nippy.html#var-id-ratio"><span>id-ratio</span></a></li><li><a href="taoensso.nippy.html#var-id-reader"><span>id-reader</span></a></li><li><a href="taoensso.nippy.html#var-id-record"><span>id-record</span></a></li><li><a href="taoensso.nippy.html#var-id-reserved"><span>id-reserved</span></a></li><li><a href="taoensso.nippy.html#var-id-seq"><span>id-seq</span></a></li><li><a href="taoensso.nippy.html#var-id-serializable"><span>id-serializable</span></a></li><li><a href="taoensso.nippy.html#var-id-set"><span>id-set</span></a></li><li><a href="taoensso.nippy.html#var-id-short"><span>id-short</span></a></li><li><a href="taoensso.nippy.html#var-id-sorted-map"><span>id-sorted-map</span></a></li><li><a href="taoensso.nippy.html#var-id-sorted-set"><span>id-sorted-set</span></a></li><li><a href="taoensso.nippy.html#var-id-string"><span>id-string</span></a></li><li><a href="taoensso.nippy.html#var-id-uuid"><span>id-uuid</span></a></li><li><a href="taoensso.nippy.html#var-id-vector"><span>id-vector</span></a></li><li><a href="taoensso.nippy.html#var-map-%3ECompressable-LZMA2"><span>map->Compressable-LZMA2</span></a></li><li><a href="taoensso.nippy.html#var-map-%3EStressRecord"><span>map->StressRecord</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><li><a href="taoensso.nippy.html#var-thaw-from-stream%21"><span>thaw-from-stream!</span></a></li><li><a href="taoensso.nippy.html#var-write-id"><span>write-id</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
|
|
from Deep-Freeze.</pre><div class="public" id="var--%3ECompressable-LZMA2"><h3>->Compressable-LZMA2</h3><div class="usage"><code>(->Compressable-LZMA2 value)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.Compressable-LZMA2.
|
|
</pre></div><div class="public" id="var--%3EStressRecord"><h3>->StressRecord</h3><div class="usage"><code>(->StressRecord data)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.StressRecord.
|
|
</pre></div><div class="public" id="var-Freezable"><h3>Freezable</h3><div class="usage"></div><pre class="doc">Be careful about extending to interfaces, Ref. http://goo.gl/6gGRlU.
|
|
</pre></div><div class="public" id="var-custom-readers"><h3>custom-readers</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-extend-freeze"><h3>extend-freeze</h3><h4 class="macro">macro</h4><div class="usage"><code>(extend-freeze type custom-type-id [x stream] & body)</code></div><pre class="doc">Alpha - subject to change.
|
|
Extends Nippy to support freezing of a custom type (ideally concrete) with
|
|
id ∈[1, 128]:
|
|
(defrecord MyType [data])
|
|
(extend-freeze MyType 1 [x data-output-stream]
|
|
(.writeUTF [data-output-stream] (:data x)))</pre></div><div class="public" id="var-extend-thaw"><h3>extend-thaw</h3><h4 class="macro">macro</h4><div class="usage"><code>(extend-thaw custom-type-id [stream] & body)</code></div><pre class="doc">Alpha - subject to change.
|
|
Extends Nippy to support thawing of a custom type with id ∈[1, 128]:
|
|
(extend-thaw 1 [data-input-stream]
|
|
(->MyType (.readUTF data-input-stream)))</pre></div><div class="public" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x & [{:keys [password compressor encryptor legacy-mode], :or {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 readable by Nippy < 2.x. For custom types extend the
|
|
Clojure reader or see `extend-freeze`.</pre></div><div class="public" id="var-freeze-to-bytes"><h3>freeze-to-bytes</h3><div class="usage"><code>(freeze-to-bytes x & {:keys [compress?], :or {compress? true}})</code></div><pre class="doc">DEPRECATED: Use `freeze` instead.
|
|
</pre></div><div class="public" id="var-freeze-to-stream%21"><h3>freeze-to-stream!</h3><div class="usage"><code>(freeze-to-stream! data-output-stream x & _)</code></div><pre class="doc">Low-level API. Serializes arg (any Clojure data type) to a DataOutputStream.
|
|
</pre></div><div class="public" id="var-freeze-to-stream*"><h3>freeze-to-stream*</h3><div class="usage"><code>(freeze-to-stream* this stream)</code></div><pre class="doc"></pre></div><div class="public" id="var-id-bigdec"><h3>id-bigdec</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-bigint"><h3>id-bigint</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-boolean"><h3>id-boolean</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-byte"><h3>id-byte</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-bytes"><h3>id-bytes</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-char"><h3>id-char</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-date"><h3>id-date</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-double"><h3>id-double</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-float"><h3>id-float</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-integer"><h3>id-integer</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-keyword"><h3>id-keyword</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-list"><h3>id-list</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-long"><h3>id-long</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-map"><h3>id-map</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-meta"><h3>id-meta</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-nil"><h3>id-nil</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-old-keyword"><h3>id-old-keyword</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-old-map"><h3>id-old-map</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-old-reader"><h3>id-old-reader</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-old-string"><h3>id-old-string</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-queue"><h3>id-queue</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-ratio"><h3>id-ratio</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-reader"><h3>id-reader</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-record"><h3>id-record</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-reserved"><h3>id-reserved</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-seq"><h3>id-seq</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-serializable"><h3>id-serializable</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-set"><h3>id-set</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-short"><h3>id-short</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-sorted-map"><h3>id-sorted-map</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-sorted-set"><h3>id-sorted-set</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-string"><h3>id-string</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-uuid"><h3>id-uuid</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-id-vector"><h3>id-vector</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-map-%3ECompressable-LZMA2"><h3>map->Compressable-LZMA2</h3><div class="usage"><code>(map->Compressable-LZMA2 m__5665__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
|
|
</pre></div><div class="public" id="var-map-%3EStressRecord"><h3>map->StressRecord</h3><div class="usage"><code>(map->StressRecord m__5665__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
|
|
</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 & benchmarks.
|
|
</pre></div><div class="public" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba & [{:keys [password compressor encryptor legacy-opts], :or {legacy-opts {:compressed? true}, compressor snappy-compressor, encryptor aes128-encryptor}, :as opts}])</code></div><pre class="doc">Deserializes a frozen object from given byte array to its original Clojure
|
|
data type. Supports data frozen with current and all previous versions of
|
|
Nippy. For custom types extend the Clojure reader or see `extend-thaw`.</pre></div><div class="public" id="var-thaw-from-bytes"><h3>thaw-from-bytes</h3><div class="usage"><code>(thaw-from-bytes ba & {:keys [compressed?], :or {compressed? true}})</code></div><pre class="doc">DEPRECATED: Use `thaw` instead.
|
|
</pre></div><div class="public" id="var-thaw-from-stream%21"><h3>thaw-from-stream!</h3><div class="usage"><code>(thaw-from-stream! data-input-stream & _)</code></div><pre class="doc">Low-level API. Deserializes a frozen object from given DataInputStream to its
|
|
original Clojure data type.</pre></div><div class="public" id="var-write-id"><h3>write-id</h3><h4 class="macro">macro</h4><div class="usage"><code>(write-id s id)</code></div><pre class="doc"></pre></div></div></body></html> |