<html><head><metacharset="UTF-8"/><title>Nippy 3.2.0</title><linkrel="stylesheet"type="text/css"href="css/default.css"/><linkrel="stylesheet"type="text/css"href="css/highlight.css"/><scripttype="text/javascript"src="js/highlight.min.js"></script><scripttype="text/javascript"src="js/jquery.min.js"></script><scripttype="text/javascript"src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divid="header"><h2>Generated by <ahref="https://github.com/weavejester/codox">Codox</a></h2><h1><ahref="index.html"><spanclass="project-title"><spanclass="project-name">Nippy</span><spanclass="project-version">3.2.0</span></span></a></h1></div><divclass="sidebar primary"><h3class="no-link"><spanclass="inner">Project</span></h3><ulclass="index-link"><liclass="depth-1 current"><ahref="index.html"><divclass="inner">Index</div></a></li></ul><h3class="no-link"><spanclass="inner">Namespaces</span></h3><ul><liclass="depth-1"><divclass="no-link"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>taoensso</span></div></div></li><liclass="depth-2"><ahref="taoensso.nippy.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>nippy</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.benchmarks.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>benchmarks</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.compression.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>compression</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.crypto.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>crypto</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.encryption.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>encryption</span></div></a></li><liclass="depth-3 branch"><ahref="taoensso.nippy.tools.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>tools</span></div></a></li><liclass="depth-3"><ahref="taoensso.nippy.utils.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>utils</span></div></a></li></ul></div><divclass="namespace-index"id="content"><h1><spanclass="project-title"><spanclass="project-name">Nippy</span><spanclass="project-version">3.2.0</span></span></h1><h5class="license">Released under the <ahref="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License</a></h5><divclass="doc"><p>High-performance serialization library for Clojure.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><preclass="deps">[com.taoensso/nippy "3.2.0"]</pre><h2>Namespaces</h2><divclass="namespace"><h3><ahref="taoensso.nippy.html">taoensso.nippy</a></h3><divclass="doc"><preclass="plaintext">High-performance serialization library for Clojure</pre></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="taoensso.nippy.html#var-*auto-freeze-compressor*">*auto-freeze-compressor*</a></li><li><ahref="taoensso.nippy.html#var-*custom-readers*">*custom-readers*</a></li><li><ahref="taoensso.nippy.html#var-*final-freeze-fallback*">*final-freeze-fallback*</a></li><li><ahref="taoensso.nippy.html#var-*freeze-fallback*">*freeze-fallback*</a></li><li><ahref="taoensso.nippy.html#var-*freeze-serializable-allowlist*">*freeze-serializable-allowlist*</a></li><li><ahref="taoensso.nippy.html#var-*incl-metadata.3F*">*incl-metadata?*</a></li><li><ahref="taoensso.nippy.html#var-*serializable-whitelist*">*serializable-whitelist*</a></li><li><ahref="taoensso.nippy.html#var-*thaw-serializable-allowlist*">*thaw-serializable-allowlist*</a></li><li><ahref="taoenss
Private & alpha, very likely to change!</pre></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="taoensso.nippy.crypto.html#var-cbc-cipher">cbc-cipher</a></li><li><ahref="taoensso.nippy.crypto.html#var-cipher-kit-aes-cbc">cipher-kit-aes-cbc</a></li><li><ahref="taoensso.nippy.crypto.html#var-cipher-kit-aes-gcm">cipher-kit-aes-gcm</a></li><li><ahref="taoensso.nippy.crypto.html#var-decrypt">decrypt</a></li><li><ahref="taoensso.nippy.crypto.html#var-encrypt">encrypt</a></li><li><ahref="taoensso.nippy.crypto.html#var-gcm-cipher">gcm-cipher</a></li><li><ahref="taoensso.nippy.crypto.html#var-ICipherKit">ICipherKit</a></li><li><ahref="taoensso.nippy.crypto.html#var-murmur3">murmur3</a></li><li><ahref="taoensso.nippy.crypto.html#var-pwd-as-ba">pwd-as-ba</a></li><li><ahref="taoensso.nippy.crypto.html#var-rand-bool">rand-bool</a></li><li><ahref="taoensso.nippy.crypto.html#var-rand-bytes">rand-bytes</a></li><li><ahref="taoensso.nippy.crypto.html#var-rand-double">rand-double</a></li><li><ahref="taoensso.nippy.crypto.html#var-rand-gauss">rand-gauss</a></li><li><ahref="taoensso.nippy.crypto.html#var-rand-long">rand-long</a></li><li><ahref="taoensso.nippy.crypto.html#var-rand-nth">rand-nth</a></li><li><ahref="taoensso.nippy.crypto.html#var-sha256-ba">sha256-ba</a></li><li><ahref="taoensso.nippy.crypto.html#var-sha256-md">sha256-md</a></li><li><ahref="taoensso.nippy.crypto.html#var-sha512-ba">sha512-ba</a></li><li><ahref="taoensso.nippy.crypto.html#var-sha512-key-ba">sha512-key-ba</a></li><li><ahref="taoensso.nippy.crypto.html#var-sha512-md">sha512-md</a></li><li><ahref="taoensso.nippy.crypto.html#var-take-ba">take-ba</a></li><li><ahref="taoensso.nippy.crypto.html#var-utf8-.3Eba">utf8->ba</a></li></ul></div></div><divclass="namespace"><h3><ahref="taoensso.nippy.encryption.html">taoensso.nippy.encryption</a></h3><divclass="doc"><preclass="plaintext">Simple no-nonsense crypto with reasonable defaults</pre></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="taoensso.nippy.encryption.html#var-aes128-cbc-encryptor">aes128-cbc-encryptor</a></li><li><ahref="taoensso.nippy.encryption.html#var-aes128-gcm-encryptor">aes128-gcm-encryptor</a></li><li><ahref="taoensso.nippy.encryption.html#var-IEncryptor">IEncryptor</a></li><li><ahref="taoensso.nippy.encryption.html#var-standard-header-ids">standard-header-ids</a></li></ul></div></div><divclass="namespace"><h3><ahref="taoensso.nippy.tools.html">taoensso.nippy.tools</a></h3><divclass="doc"><preclass="plaintext">Utils for 3rd-party tools that want to add user-configurable Nippy support.
Used by Carmine, Faraday, etc.</pre></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="taoensso.nippy.tools.html#var-*freeze-opts*">*freeze-opts*</a></li><li><ahref="taoensso.nippy.tools.html#var-*thaw-opts*">*thaw-opts*</a></li><li><ahref="taoensso.nippy.tools.html#var-freeze">freeze</a></li><li><ahref="taoensso.nippy.tools.html#var-thaw">thaw</a></li><li><ahref="taoensso.nippy.tools.html#var-with-freeze-opts">with-freeze-opts</a></li><li><ahref="taoensso.nippy.tools.html#var-with-thaw-opts">with-thaw-opts</a></li><li><ahref="taoensso.nippy.tools.html#var-wrap-for-freezing">wrap-for-freezing</a></li><li><ahref="taoensso.nippy.tools.html#var-wrapped-for-freezing.3F">wrapped-for-freezing?</a></li></ul></div></div><divclass="namespace"><h3><ahref="taoensso.nippy.utils.html">taoensso.nippy.utils</a></h3><divclass="doc"><preclass="plaintext"></pre></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="taoensso.nippy.utils.html#var-freezable.3F">freezable?</a></li><li><ahref="taoensso.nippy.utils.html#var-readable.3F">readable?</a></li><li><ahref="taoensso.nippy.utils.html#var-serializable.3F">serializable?</a></li></ul></div></div></div></body></html>
