<html><head><metacharset="UTF-8"><linkhref="css/default.css"rel="stylesheet"type="text/css"><scriptsrc="js/jquery.min.js"type="text/javascript"></script><scriptsrc="js/page_effects.js"type="text/javascript"></script><title>taoensso.nippy.tools documentation</title></head><body><divid="header"><h2>Generated by <ahref="https://github.com/weavejester/codox">Codox</a></h2><h1><ahref="index.html">Nippy 2.7.0-alpha1 API documentation</a></h1></div><divclass="sidebar"id="namespaces"><h3><ahref="index.html"><spanclass="inner">Namespaces</span></a></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.encryption.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>encryption</span></div></a></li><liclass="depth-3 branch current"><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="sidebar"id="vars"><h3><ahref="#top"><spanclass="inner">Public Vars</span></a></h3><ul><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-*thaw-opts*"><divclass="inner"><span>*thaw-opts*</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var--.3EWrappedForFreezing"><divclass="inner"><span>->WrappedForFreezing</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-freeze"><divclass="inner"><span>freeze</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-map-.3EWrappedForFreezing"><divclass="inner"><span>map->WrappedForFreezing</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-thaw"><divclass="inner"><span>thaw</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-with-thaw-opts"><divclass="inner"><span>with-thaw-opts</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-wrap-for-freezing"><divclass="inner"><span>wrap-for-freezing</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-wrapped-for-freezing.3F"><divclass="inner"><span>wrapped-for-freezing?</span></div></a></li></ul></div><divclass="namespace-docs"id="content"><h2class="anchor"id="top">taoensso.nippy.tools</h2><divclass="doc"><preclass="plaintext">Utilities for third-party tools that want to add fully-user-configurable
Nippy support. Used by Carmine and Faraday.</pre></div><divclass="public anchor"id="var-*thaw-opts*"><h3>*thaw-opts*</h3><h4class="dynamic">dynamic</h4><divclass="usage"></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var--.3EWrappedForFreezing"><h3>->WrappedForFreezing</h3><divclass="usage"><code>(->WrappedForFreezing value opts)</code></div><divclass="doc"><preclass="plaintext">Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
</pre></div></div><divclass="public anchor"id="var-freeze"><h3>freeze</h3><divclass="usage"><code>(freeze x & [{:keys [default-opts]}])</code></div><divclass="doc"><preclass="plaintext">Like `nippy/freeze` but takes options from special argument wrapper when
present.</pre></div></div><divclass="public anchor"id="var-map-.3EWrappedForFreezing"><h3>map->WrappedForFreezing</h3><divclass="usage"><code>(map->WrappedForFreezing m__5869__auto__)</code></div><divclass="doc"><preclass="plaintext">Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
</pre></div></div><divclass="public anchor"id="var-thaw"><h3>thaw</h3><divclass="usage"><code>(thaw ba & [{:keys [default-opts]}])</code></div><divclass="doc"><preclass="plaintext">Like `nippy/thaw` but takes options from *thaw-opts* binding.
</pre></div></div><divclass="public anchor"id="var-with-thaw-opts"><h3>with-thaw-opts</h3><h4class="type">macro</h4><divclass="usage"><code>(with-thaw-opts opts & body)</code></div><divclass="doc"><preclass="plaintext">Evaluates body using given options for any automatic deserialization in
context.</pre></div></div><divclass="public anchor"id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><divclass="usage"><code>(wrap-for-freezing value & [opts])</code></div><divclass="doc"><preclass="plaintext">Wraps arg (any freezable data type) so that (tools/freeze <wrapped-arg>)
will serialize the arg using given options.</pre></div></div><divclass="public anchor"id="var-wrapped-for-freezing.3F"><h3>wrapped-for-freezing?</h3><divclass="usage"><code>(wrapped-for-freezing? x)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div></div></body></html>
