</pre></div></div><divclass="public anchor"id="var--.3ECompressable-LZMA2"><h3>->Compressable-LZMA2</h3><divclass="usage"><code>(->Compressable-LZMA2 value)</code></div><divclass="doc"><preclass="plaintext">Positional factory function for class taoensso.nippy.Compressable-LZMA2.
</pre></div></div><divclass="public anchor"id="var--.3EStressRecord"><h3>->StressRecord</h3><divclass="usage"><code>(->StressRecord data)</code></div><divclass="doc"><preclass="plaintext">Positional factory function for class taoensso.nippy.StressRecord.
</pre></div></div><divclass="public anchor"id="var-aes128-encryptor"><h3>aes128-encryptor</h3><divclass="usage"></div><divclass="doc"><preclass="plaintext">Default 128bit AES encryptor with multi-round SHA-512 key-gen.
Password form [:salted "my-password"]
---------------------------------------
USE CASE: You want more than a small, finite number of passwords (e.g. each
increased danger if a key is somehow compromised.</pre></div></div><divclass="public anchor"id="var-default-freeze-compressor-selector"><h3>default-freeze-compressor-selector</h3><divclass="usage"><code>(default-freeze-compressor-selector ba)</code></div><divclass="doc"><preclass="plaintext">Strategy:
space overhead.</pre></div></div><divclass="public anchor"id="var-extend-freeze"><h3>extend-freeze</h3><h4class="type">macro</h4><divclass="usage"><code>(extend-freeze type custom-type-id [x out] & body)</code></div><divclass="doc"><preclass="plaintext">Extends Nippy to support freezing of a custom type (ideally concrete) with
(extend-freeze MyType :foo/my-type [x data-output] ; Keyword id
(.writeUTF [data-output] (:data x)))
;; or
(extend-freeze MyType 1 [x data-output] ; Byte id
(.writeUTF [data-output] (:data x)))</pre></div></div><divclass="public anchor"id="var-extend-thaw"><h3>extend-thaw</h3><h4class="type">macro</h4><divclass="usage"><code>(extend-thaw custom-type-id [in] & body)</code></div><divclass="doc"><preclass="plaintext">Extends Nippy to support thawing of a custom type with given id:
(extend-thaw :foo/my-type [data-input] ; Keyword id
(->MyType (.readUTF data-input)))
;; or
(extend-thaw 1 [data-input] ; Byte id
(->MyType (.readUTF data-input)))</pre></div></div><divclass="public anchor"id="var-Freezable"><h3>Freezable</h3><h4class="type">protocol</h4><divclass="usage"></div><divclass="doc"><preclass="plaintext">Be careful about extending to interfaces, Ref. <ahref="http://goo.gl/6gGRlU">http://goo.gl/6gGRlU</a>.
</pre></div><divclass="members"><h4>members</h4><divclass="inner"><divclass="public anchor"id="var-freeze-to-out*"><h3>freeze-to-out*</h3><divclass="usage"><code>(freeze-to-out* this out)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div></div></div></div><divclass="public anchor"id="var-freezable.3F"><h3>freezable?</h3><divclass="usage"><code>(freezable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])</code></div><divclass="doc"><preclass="plaintext">Alpha - subject to change, MAY BE BUGGY!
pre/post serialization equality (there's no good general way of doing so).</pre></div></div><divclass="public anchor"id="var-freeze"><h3>freeze</h3><divclass="usage"><code>(freeze x)</code><code>(freeze x {:keys [compressor encryptor password skip-header?], :or {compressor :auto, encryptor aes128-encryptor}, :as opts})</code></div><divclass="doc"><preclass="plaintext">Serializes arg (any Clojure data type) to a byte array. To freeze custom
types, extend the Clojure reader or see `extend-freeze`.</pre></div></div><divclass="public anchor"id="var-freeze-fallback-as-str"><h3>freeze-fallback-as-str</h3><divclass="usage"><code>(freeze-fallback-as-str x out)</code></div><divclass="doc"><preclass="plaintext">Alpha-subject to change.
</pre></div></div><divclass="public anchor"id="var-freeze-to-out.21"><h3>freeze-to-out!</h3><divclass="usage"><code>(freeze-to-out! data-output x)</code></div><divclass="doc"><preclass="plaintext">Low-level API. Serializes arg (any Clojure data type) to a DataOutput.
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.
environments.</pre></div></div><divclass="public anchor"id="var-map-.3ECompressable-LZMA2"><h3>map->Compressable-LZMA2</h3><divclass="usage"><code>(map->Compressable-LZMA2 m__6289__auto__)</code></div><divclass="doc"><preclass="plaintext">Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
</pre></div></div><divclass="public anchor"id="var-map-.3EStressRecord"><h3>map->StressRecord</h3><divclass="usage"><code>(map->StressRecord m__6289__auto__)</code></div><divclass="doc"><preclass="plaintext">Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
</pre></div></div><divclass="public anchor"id="var-read-biginteger"><h3>read-biginteger</h3><h4class="type">macro</h4><divclass="usage"><code>(read-biginteger in)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-read-bytes"><h3>read-bytes</h3><h4class="type">macro</h4><divclass="usage"><code>(read-bytes in & [small?])</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-read-compact-long"><h3>read-compact-long</h3><h4class="type">macro</h4><divclass="usage"><code>(read-compact-long in)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-read-utf8"><h3>read-utf8</h3><h4class="type">macro</h4><divclass="usage"><code>(read-utf8 in & [small?])</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-set-default-freeze-compressor-selector.21"><h3>set-default-freeze-compressor-selector!</h3><divclass="usage"><code>(set-default-freeze-compressor-selector! selector)</code></div><divclass="doc"><preclass="plaintext">Sets root binding of `*default-freeze-compressor-selector*`.
A good general-purpose compressor.</pre></div></div><divclass="public anchor"id="var-stress-data"><h3>stress-data</h3><divclass="usage"></div><divclass="doc"><preclass="plaintext">Reference data used for tests & benchmarks.
</pre></div></div><divclass="public anchor"id="var-stress-data-benchable"><h3>stress-data-benchable</h3><divclass="usage"></div><divclass="doc"><preclass="plaintext">Reference data with stuff removed that breaks reader or other utils we'll
be benching against.</pre></div></div><divclass="public anchor"id="var-stress-data-comparable"><h3>stress-data-comparable</h3><divclass="usage"></div><divclass="doc"><preclass="plaintext">Reference data with stuff removed that breaks roundtrip equality.
</pre></div></div><divclass="public anchor"id="var-swap-custom-readers.21"><h3>swap-custom-readers!</h3><divclass="usage"><code>(swap-custom-readers! f)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-thaw"><h3>thaw</h3><divclass="usage"><code>(thaw ba)</code><code>(thaw ba {:keys [v1-compatibility? compressor encryptor password], :or {v1-compatibility? true, compressor :auto, encryptor :auto}, :as opts})</code></div><divclass="doc"><preclass="plaintext">Deserializes a frozen object from given byte array to its original Clojure
:encryptor - An IEncryptor, :auto (requires Nippy header), or nil.</pre></div></div><divclass="public anchor"id="var-thaw-from-in.21"><h3>thaw-from-in!</h3><divclass="usage"><code>(thaw-from-in! data-input)</code></div><divclass="doc"><preclass="plaintext">Low-level API. Deserializes a frozen object from given DataInput to its
original Clojure data type.</pre></div></div><divclass="public anchor"id="var-when-debug-mode"><h3>when-debug-mode</h3><h4class="type">macro</h4><divclass="usage"><code>(when-debug-mode & body)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-write-biginteger"><h3>write-biginteger</h3><h4class="type">macro</h4><divclass="usage"><code>(write-biginteger out x)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-write-bytes"><h3>write-bytes</h3><h4class="type">macro</h4><divclass="usage"><code>(write-bytes out ba & [small?])</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-write-compact-long"><h3>write-compact-long</h3><h4class="type">macro</h4><divclass="usage"><code>(write-compact-long out x)</code></div><divclass="doc"><preclass="plaintext">Uses 2->9 bytes.
</pre></div></div><divclass="public anchor"id="var-write-id"><h3>write-id</h3><h4class="type">macro</h4><divclass="usage"><code>(write-id out id)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-write-utf8"><h3>write-utf8</h3><h4class="type">macro</h4><divclass="usage"><code>(write-utf8 out x & [small?])</code></div><divclass="doc"><preclass="plaintext"></pre></div></div></div></body></html>
