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

v3.3.0-RC1 (2023-08-02)

Browse source
This commit is contained in:
Peter Taoussanis 2023-08-02 14:39:18 +02:00
parent 8025f3501c
commit 6e9d293f96
5 changed files with 132 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
css/default.css
View file

@ -44,7 +44,7 @@ h5.license {
right: 0; right: 0;
height: 22px; height: 22px;
color: #f5f5f5; color: #f5f5f5;
padding: 5px 7px; padding: 7px 10px;
} }
#content { #content {
@ -92,16 +92,17 @@ h5.license {
#header { #header {
background: #3f3f3f; background: #3f3f3f;
box-shadow: 0 0 8px rgba(0, 0, 0, 0.4); border-bottom: 1px solid #cccccc;
z-index: 100; z-index: 100;
} }
#header h1 { #header h1 {
display: block;
float: left;
margin: 0; margin: 0;
padding: 0; padding: 0;
font-size: 18px; font-size: 18px;
font-weight: lighter; font-weight: lighter;
text-shadow: -1px -1px 0px #333;
} }
#header h1 .project-version { #header h1 .project-version {
@ -121,6 +122,26 @@ h5.license {
color: #f5f5f5; color: #f5f5f5;
} }
#langs {
display: block;
float: left;
font-size: 16px;
margin: 0 10px;
}
#langs .lang {
display: inline-block;
margin: 0 2px;
padding: 0 7px;
background-color: #717171;
border-radius: 6px;
vertical-align: middle;
}
#langs .lang.current {
background-color: #a33;
}
.sidebar a { .sidebar a {
color: #333; color: #333;
} }
@ -325,7 +346,8 @@ h5.license {
h4.type, h4.type,
h4.dynamic, h4.dynamic,
h4.added, h4.added,
h4.deprecated { h4.deprecated,
h4.lang {
float: left; float: left;
margin: 3px 10px 15px 0; margin: 3px 10px 15px 0;
font-size: 15px; font-size: 15px;
@ -336,7 +358,8 @@ h4.deprecated {
.public h4.type, .public h4.type,
.public h4.dynamic, .public h4.dynamic,
.public h4.added, .public h4.added,
.public h4.deprecated { .public h4.deprecated,
.public h4.lang {
font-size: 13px; font-size: 13px;
font-weight: bold; font-weight: bold;
margin: 3px 0 0 10px; margin: 3px 0 0 10px;
@ -344,7 +367,8 @@ h4.deprecated {
.members h4.type, .members h4.type,
.members h4.added, .members h4.added,
.members h4.deprecated { .members h4.deprecated,
.members h4.lang {
margin-top: 1px; margin-top: 1px;
} }
@ -364,6 +388,16 @@ h4.deprecated {
color: #880000; color: #880000;
} }
.public h4.lang, .public h4.lang a {
font-weight: normal;
font-variant: normal;
color: #717171;
}
.public h4.lang.current {
color: #a33;
}
.namespace { .namespace {
margin-bottom: 30px; margin-bottom: 30px;
} }

5
index.html
View file

File diff suppressed because one or more lines are too long

4
taoensso.nippy.benchmarks.html
View file

@ -1,3 +1,5 @@
<!DOCTYPE html PUBLIC "" <!DOCTYPE html PUBLIC ""
""> "">
<html><head><meta charset="UTF-8" /><title>taoensso.nippy.benchmarks 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 current"><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"><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.benchmarks.html#var-bench"><div class="inner"><span>bench</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.benchmarks.html#var-bench*"><div class="inner"><span>bench*</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.benchmarks.html#var-bench1"><div class="inner"><span>bench1</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.benchmarks.html#var-data"><div class="inner"><span>data</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.benchmarks.html#var-fressian-freeze"><div class="inner"><span>fressian-freeze</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.benchmarks.html#var-fressian-thaw"><div class="inner"><span>fressian-thaw</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.nippy.benchmarks</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-bench"><h3>bench</h3><div class="usage"><code>(bench {:keys [reader? lzma2? fressian? laps], :or {laps 1}})</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-bench*"><h3>bench*</h3><h4 class="type">macro</h4><div class="usage"><code>(bench* &amp; body)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-bench1"><h3>bench1</h3><div class="usage"><code>(bench1 freezer thawer &amp; [sizer])</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-data"><h3>data</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-fressian-freeze"><h3>fressian-freeze</h3><div class="usage"><code>(fressian-freeze value)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-fressian-thaw"><h3>fressian-thaw</h3><div class="usage"><code>(fressian-thaw value)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></body></html> <html><head><meta charset="UTF-8" /><title>taoensso.nippy.benchmarks 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.3.0-RC1</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 current"><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"><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></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.benchmarks.html#var-bench"><div class="inner"><span>bench</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.benchmarks.html#var-data"><div class="inner"><span>data</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.nippy.benchmarks</h1><div class="doc"><pre class="plaintext">Nippy benchmarks.
</pre></div><div class="public anchor" id="var-bench"><h3>bench</h3><div class="usage"><code>(bench {:keys [all? reader? fressian? fressian? lzma2? laps warmup], :or {laps 10000.0, warmup 25000.0}})</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-data"><h3>data</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Map of data suitable for benching, a subset of
`nippy/stress-data-comparable`.</pre></div></div></div></body></html>

84
taoensso.nippy.html
View file

File diff suppressed because one or more lines are too long

26
taoensso.nippy.tools.html
View file

@ -1,17 +1,19 @@
<!DOCTYPE html PUBLIC "" <!DOCTYPE html PUBLIC ""
""> "">
<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. <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.3.0-RC1</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 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></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-freeze-opts.2B"><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-with-thaw-opts.2B"><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 community tools that want to add user-configurable Nippy support.
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 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 options the following, merged in
ascending preference: order of ascending preference:
- Optional `default-opts` arg given to this fn (default nil). 1. `default-opts` given to this fn (default nil).
- Optional `*freeze-opts*` dynamic value (default nil). 2. `tools/*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 3. Opts captured by `tools/wrap-for-freezing` (default nil).
ascending preference:
- Optional `default-opts` arg given to this fn (default nil). See also `tools/wrap-for-freezing`.</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 options the following, merged in
- 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 order of ascending preference:
(tools/freeze &lt;wrapped-arg&gt;) will serialize as
(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> 1. `default-opts` given to this fn (default nil).
2. `tools/*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-freeze-opts.2B"><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-with-thaw-opts.2B"><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 wrap-opts)</code></div><div class="doc"><pre class="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><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>