</pre></div><divclass="public anchor"id="var-*auto-freeze-compressor*"><h3>*auto-freeze-compressor*</h3><h4class="dynamic">dynamic</h4><divclass="usage"></div><divclass="doc"><preclass="plaintext">(fn [byte-array])->compressor used by `(freeze <x> {:compressor :auto}),
</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L241">view source</a></div></div><divclass="public anchor"id="var--.3ECacheWrapped"><h3>->CacheWrapped</h3><divclass="usage"><code>(->CacheWrapped val)</code></div><divclass="doc"><preclass="plaintext">Positional factory function for class taoensso.nippy.CacheWrapped.
</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L751">view source</a></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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L1448">view source</a></div></div><divclass="public anchor"id="var--cache-proxy"><h3>-cache-proxy</h3><divclass="usage"></div><divclass="doc"><preclass="plaintext">{[<x><meta>] <idx>} for freezing, {<idx><x-with-meta>} for thawing.
</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L733">view source</a></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 many-round SHA-512 key-gen.
increased danger if a key is somehow compromised.</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L232">view source</a></div></div><divclass="public anchor"id="var-cache"><h3>cache</h3><divclass="usage"><code>(cache x)</code></div><divclass="doc"><preclass="plaintext">Experimental, subject to change.
Wraps value so that future writes of the same wrapped value with same
metadata will be efficiently encoded as references to this one.
will incl. a single "foo", plus 2x single-byte references to "foo".</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L752">view source</a></div></div><divclass="public anchor"id="var-compress"><h3>compress</h3><divclass="usage"><code>(compress compressor ba)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L223">view source</a></div></div><divclass="public anchor"id="var-decompress"><h3>decompress</h3><divclass="usage"><code>(decompress compressor ba)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L224">view source</a></div></div><divclass="public anchor"id="var-decrypt"><h3>decrypt</h3><divclass="usage"><code>(decrypt encryptor pwd ba)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L231">view source</a></div></div><divclass="public anchor"id="var-encrypt"><h3>encrypt</h3><divclass="usage"><code>(encrypt encryptor pwd ba)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L230">view source</a></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
(.writeUTF [data-output] (:data x)))</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L1393">view source</a></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:
way of doing so).</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L234">view source</a></div></div><divclass="public anchor"id="var-freeze"><h3>freeze</h3><divclass="usage"><code>(freeze x)</code><code>(freeze x {:keys [compressor encryptor password], :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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L943">view source</a></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">Serializes arg (any Clojure data type) to a DataOutput.
This is a low-level util: in most cases you'll want `freeze` instead.</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L712">view source</a></div></div><divclass="public anchor"id="var-IFreezable1"><h3>IFreezable1</h3><h4class="type">protocol</h4><divclass="usage"></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="members"><h4>members</h4><divclass="inner"><divclass="public anchor"id="var--freeze-without-meta.21"><h3>-freeze-without-meta!</h3><divclass="usage"><code>(-freeze-without-meta! x data-output)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div></div></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L303">view source</a></div></div><divclass="public anchor"id="var-IFreezable2"><h3>IFreezable2</h3><h4class="type">protocol</h4><divclass="usage"></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="members"><h4>members</h4><divclass="inner"><divclass="public anchor"id="var--freeze-with-meta.21"><h3>-freeze-with-meta!</h3><divclass="usage"><code>(-freeze-with-meta! x data-output)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div></div></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L304">view source</a></div></div><divclass="public anchor"id="var-inspect-ba"><h3>inspect-ba</h3><divclass="usage"><code>(inspect-ba ba)</code><code>(inspect-ba ba thaw-opts)</code></div><divclass="doc"><preclass="plaintext">Alpha - subject to change
Ref. <ahref="https://github.com/mpenet/nippy-lz4">https://github.com/mpenet/nippy-lz4</a></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L227">view source</a></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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L226">view source</a></div></div><divclass="public anchor"id="var-map-.3EStressRecord"><h3>map->StressRecord</h3><divclass="usage"><code>(map->StressRecord m__8622__auto__)</code></div><divclass="doc"><preclass="plaintext">Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
A good general-purpose compressor.</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L225">view source</a></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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L1449">view source</a></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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L1517">view source</a></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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L1513">view source</a></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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L250">view source</a></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 {compressor :auto, encryptor :auto}, :as opts})</code></div><divclass="doc"><preclass="plaintext">Deserializes a frozen Nippy byte array to its original Clojure data type.
:encryptor - :auto (checks header, default), an IEncryptor, or nil</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L1272">view source</a></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">Deserializes a frozen object from given DataInput to its original Clojure
data type.
This is a low-level util: in most cases you'll want `thaw` instead.</pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L1093">view source</a></div></div><divclass="public anchor"id="var-throw-unfreezable"><h3>throw-unfreezable</h3><divclass="usage"><code>(throw-unfreezable x)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L705">view source</a></div></div><divclass="public anchor"id="var-try-write-readable"><h3>try-write-readable</h3><divclass="usage"><code>(try-write-readable out x)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L684">view source</a></div></div><divclass="public anchor"id="var-try-write-serializable"><h3>try-write-serializable</h3><divclass="usage"><code>(try-write-serializable out x)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L677">view source</a></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><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L289">view source</a></div></div><divclass="public anchor"id="var-write-unfreezable"><h3>write-unfreezable</h3><divclass="usage"><code>(write-unfreezable out x)</code></div><divclass="doc"><preclass="plaintext"></pre></div><divclass="src-link"><ahref="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy.clj#L699">view source</a></div></div></div></body></html>
