luciano/nippy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
nippy/taoensso.nippy.tools.html

17 lines
6.3 KiB
HTML
Raw Normal View History

v2.11.0
2016-02-25 11:50:00 +00:00
<!DOCTYPE html PUBLIC ""
"">
v3.2.0 2022-07-18
2022-07-18 07:25:29 +00:00
<html><head><meta charset="UTF-8" /><title>taoensso.nippy.tools documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Nippy</span> <span class="project-version">3.2.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.nippy.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>nippy</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.benchmarks.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>benchmarks</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.compression.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>compression</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.crypto.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>crypto</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.encryption.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>encryption</span></div></a></li><li class="depth-3 branch current"><a href="taoensso.nippy.tools.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools</span></div></a></li><li class="depth-3"><a href="taoensso.nippy.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.nippy.tools.html#var-*freeze-opts*"><div class="inner"><span>*freeze-opts*</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var-*thaw-opts*"><div class="inner"><span>*thaw-opts*</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var-freeze"><div class="inner"><span>freeze</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var-thaw"><div class="inner"><span>thaw</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var-with-freeze-opts"><div class="inner"><span>with-freeze-opts</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var-with-thaw-opts"><div class="inner"><span>with-thaw-opts</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var-wrap-for-freezing"><div class="inner"><span>wrap-for-freezing</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var-wrapped-for-freezing.3F"><div class="inner"><span>wrapped-for-freezing?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.nippy.tools</h1><div class="doc"><pre class="plaintext">Utils for 3rd-party tools that want to add user-configurable Nippy support.
v3.2.0-RC2 2022-06-23
2022-06-23 11:36:44 +00:00
Used by Carmine, Faraday, etc.</pre></div><div class="public anchor" id="var-*freeze-opts*"><h3>*freeze-opts*</h3><h4 class="dynamic">dynamic</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-*thaw-opts*"><h3>*thaw-opts*</h3><h4 class="dynamic">dynamic</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x)</code><code>(freeze x default-opts)</code></div><div class="doc"><pre class="plaintext">Like `nippy/freeze` but uses as opts the following merged in order of
ascending preference:
- Optional `default-opts` arg given to this fn (default nil).
- Optional `*freeze-opts*` dynamic value (default nil).
- Optional opts provided to `wrap-for-freezing` (default nil).</pre></div></div><div class="public anchor" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba)</code><code>(thaw ba default-opts)</code></div><div class="doc"><pre class="plaintext">Like `nippy/thaw` but uses as opts the following merged in order of
ascending preference:
- Optional `default-opts` arg given to this fn (default nil).
- Optional `*thaw-opts*` dynamic value (default nil).</pre></div></div><div class="public anchor" id="var-with-freeze-opts"><h3>with-freeze-opts</h3><h4 class="type">macro</h4><div class="usage"><code>(with-freeze-opts opts &amp; body)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-with-thaw-opts"><h3>with-thaw-opts</h3><h4 class="type">macro</h4><div class="usage"><code>(with-thaw-opts opts &amp; body)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><div class="usage"><code>(wrap-for-freezing x)</code><code>(wrap-for-freezing x opts)</code></div><div class="doc"><pre class="plaintext">Ensures that given arg (any freezable data type) is wrapped so that
v2.12.0-beta1
2016-06-10 04:00:39 +00:00
(tools/freeze &lt;wrapped-arg&gt;) will serialize as
v3.2.0-RC2 2022-06-23
2022-06-23 11:36:44 +00:00
(nippy/freeze &lt;unwrapped-arg&gt; &lt;opts&gt;).
See also `nippy.tools/freeze`, `nippy.tools/thaw`.</pre></div></div><div class="public anchor" id="var-wrapped-for-freezing.3F"><h3>wrapped-for-freezing?</h3><div class="usage"><code>(wrapped-for-freezing? x)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></body></html>
Reference in a new issue Copy permalink