<html><head><metacharset="UTF-8"/><title>taoensso.nippy.tools documentation</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.3.0</span></span></a></h1></div><divclass="sidebar primary"><h3class="no-link"><spanclass="inner">Project</span></h3><ulclass="index-link"><liclass="depth-1 "><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 current"><ahref="taoensso.nippy.tools.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>tools</span></div></a></li></ul></div><divclass="sidebar secondary"><h3><ahref="#top"><spanclass="inner">Public Vars</span></a></h3><ul><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-*freeze-opts*"><divclass="inner"><span>*freeze-opts*</span></div></a></li><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-freeze"><divclass="inner"><span>freeze</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-freeze-opts"><divclass="inner"><span>with-freeze-opts</span></div></a></li><liclass="depth-1"><ahref="taoensso.nippy.tools.html#var-with-freeze-opts.2B"><divclass="inner"><span>with-freeze-opts+</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-with-thaw-opts.2B"><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"><h1class="anchor"id="top">taoensso.nippy.tools</h1><divclass="doc"><preclass="plaintext">Utils for community tools that want to add user-configurable Nippy support.
Used by Carmine, Faraday, etc.</pre></div><divclass="public anchor"id="var-*freeze-opts*"><h3>*freeze-opts*</h3><h4class="dynamic">dynamic</h4><divclass="usage"></div><divclass="doc"><preclass="plaintext"></pre></div></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-freeze"><h3>freeze</h3><divclass="usage"><code>(freeze x)</code><code>(freeze x default-opts)</code></div><divclass="doc"><preclass="plaintext">Like `nippy/freeze` but uses as options the following, merged in
See also `tools/wrap-for-freezing`.</pre></div></div><divclass="public anchor"id="var-thaw"><h3>thaw</h3><divclass="usage"><code>(thaw ba)</code><code>(thaw ba default-opts)</code></div><divclass="doc"><preclass="plaintext">Like `nippy/thaw` but uses as options the following, merged in
2. `tools/*thaw-opts*` dynamic value (default nil).</pre></div></div><divclass="public anchor"id="var-with-freeze-opts"><h3>with-freeze-opts</h3><h4class="type">macro</h4><divclass="usage"><code>(with-freeze-opts opts & body)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-with-freeze-opts.2B"><h3>with-freeze-opts+</h3><h4class="type">macro</h4><divclass="usage"><code>(with-freeze-opts+ opts & body)</code></div><divclass="doc"><preclass="plaintext"></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"></pre></div></div><divclass="public anchor"id="var-with-thaw-opts.2B"><h3>with-thaw-opts+</h3><h4class="type">macro</h4><divclass="usage"><code>(with-thaw-opts+ opts & body)</code></div><divclass="doc"><preclass="plaintext"></pre></div></div><divclass="public anchor"id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><divclass="usage"><code>(wrap-for-freezing x)</code><code>(wrap-for-freezing x wrap-opts)</code></div><divclass="doc"><preclass="plaintext">Captures (merge `tools/*thaw-opts*` `wrap-opts`), and returns
the given argument in a wrapped form so that `tools/freeze` will
use the captured options when freezing the wrapper argument.
See also `tools/freeze`.</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>
