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

v2.11.0-alpha1

Browse source
This commit is contained in:
Peter Taoussanis 2015-12-01 13:06:24 +07:00
parent f1bb140a18
commit 9588a13463
9 changed files with 172 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

119
css/default.css
View file

@ -9,11 +9,21 @@ pre, code {
margin: 15px 0;
}
h2 {
h1 {
font-weight: normal;
font-size: 28px;
padding: 10px 0 2px 0;
margin: 0;
margin: 10px 0 2px 0;
padding: 0;
}
h2 {
font-weight: normal;
font-size: 25px;
}
.document h1, .namespace-index h1 {
font-size: 30px;
margin-top: 12px;
}
#header, #content, .sidebar {
@ -24,14 +34,13 @@ h2 {
top: 0;
left: 0;
right: 0;
height: 20px;
background: #444;
color: #fff;
height: 22px;
color: #f5f5f5;
padding: 5px 7px;
}
#content {
top: 30px;
top: 32px;
right: 0;
bottom: 0;
overflow: auto;
@ -42,58 +51,66 @@ h2 {
.sidebar {
position: fixed;
top: 30px;
top: 32px;
bottom: 0;
overflow: auto;
}
#namespaces {
.sidebar.primary {
background: #e2e2e2;
border-right: solid 1px #cccccc;
left: 0;
width: 250px;
}
#vars {
.sidebar.secondary {
background: #f2f2f2;
border-right: solid 1px #cccccc;
left: 251px;
width: 200px;
}
.namespace-index {
#content.namespace-index, #content.document {
left: 251px;
}
.namespace-docs {
#content.namespace-docs {
left: 452px;
}
#content.document {
padding-bottom: 10%;
}
#header {
background: -moz-linear-gradient(top, #555 0%, #222 100%);
background: -webkit-linear-gradient(top, #555 0%, #333 100%);
background: -o-linear-gradient(top, #555 0%, #222 100%);
background: -ms-linear-gradient(top, #555 0%, #222 100%);
background: linear-gradient(top, #555 0%, #222 100%);
box-shadow: 0 0 8px rgba(0, 0, 0, 0.4);
z-index: 100;
background: #3f3f3f;
box-shadow: 0 0 8px rgba(0, 0, 0, 0.4);
z-index: 100;
}
#header h1 {
margin: 0;
padding: 0;
font-size: 12pt;
font-size: 18px;
font-weight: lighter;
text-shadow: -1px -1px 0px #333;
}
#header h1 .project-version {
font-weight: normal;
}
.project-version {
padding-left: 5px;
}
#header a, .sidebar a {
display: block;
text-decoration: none;
}
#header a {
color: #fff;
color: #f5f5f5;
}
.sidebar a {
@ -104,7 +121,7 @@ h2 {
float: right;
font-size: 9pt;
font-weight: normal;
margin: 3px 3px;
margin: 4px 3px;
padding: 0;
color: #bbb;
}
@ -120,11 +137,20 @@ h2 {
font-weight: normal;
}
.sidebar h3.no-link {
color: #636363;
font-weight: lighter;
}
.sidebar ul {
padding: 0.5em 0em;
padding: 7px 0 6px 0;
margin: 0;
}
.sidebar ul.index-link {
padding-bottom: 4px;
}
.sidebar li {
display: block;
vertical-align: middle;
@ -193,18 +219,37 @@ h2 {
border-left: 1px solid #aaa;
}
#namespaces li.current a {
.sidebar.primary li.current a {
border-left: 3px solid #a33;
color: #a33;
}
#vars li.current a {
.sidebar.secondary li.current a {
border-left: 3px solid #33a;
color: #33a;
}
#content h3 {
font-size: 13pt;
.namespace-index h2 {
margin: 30px 0 0 0;
}
.namespace-index h3 {
font-size: 16px;
font-weight: bold;
margin-bottom: 0;
}
.namespace-index .topics {
padding-left: 30px;
margin: 11px 0 0 0;
}
.namespace-index .topics li {
padding: 5px 0;
}
.namespace-docs h3 {
font-size: 18px;
font-weight: bold;
}
@ -375,10 +420,26 @@ p {
}
.markdown {
line-height: 18px;
font-size: 14px;
}
.markdown p, .markdown li, .markdown dt, .markdown dd, .markdown td {
line-height: 18px;
}
.markdown h2 {
font-weight: normal;
font-size: 25px;
}
#content .markdown h3 {
font-size: 20px;
}
.markdown h4 {
font-size: 15px;
}
.doc, .public, .namespace .index {
max-width: 680px;
overflow-x: visible;
@ -452,4 +513,4 @@ p {
padding: 1px 4px;
text-decoration: none;
color: #5555bb;
}
}

4
index.html
View file

File diff suppressed because one or more lines are too long

35
js/page_effects.js
View file

@ -31,15 +31,15 @@ function scrollToCurrentVarLink(elements) {
}
function setCurrentVarLink() {
$('#vars a').parent().removeClass('current')
$('.secondary a').parent().removeClass('current')
$('.anchor').
filter(function(index) { return visibleInParent(this) }).
each(function(index, element) {
findLinkByFragment("#vars a", element.id).
findLinkByFragment(".secondary a", element.id).
parent().
addClass('current')
});
scrollToCurrentVarLink('#vars .current');
scrollToCurrentVarLink('.secondary .current');
}
var hasStorage = (function() { try { return localStorage.getItem } catch(e) {} }())
@ -72,27 +72,32 @@ function sidebarContentWidth(element) {
}
function resizeSidebars() {
var nsWidth = sidebarContentWidth('#namespaces') + 30
var varWidth = 0
var primaryWidth = sidebarContentWidth('.primary') + 30
var secondaryWidth = 0
if ($('#vars').length != 0) {
varWidth = sidebarContentWidth('#vars') + 30
if ($('.secondary').length != 0) {
secondaryWidth = sidebarContentWidth('.secondary') + 30
}
// snap to grid
var snap = 30;
nsWidth = Math.ceil(nsWidth / snap) * snap;
varWidth = Math.ceil(varWidth / snap) * snap;
var snap = 30
primaryWidth = Math.ceil(primaryWidth / snap) * snap
secondaryWidth = Math.ceil(secondaryWidth / snap) * snap
$('#namespaces').css('width', nsWidth)
$('#vars').css('width', varWidth)
$('#vars, .namespace-index').css('left', nsWidth + 1)
$('.namespace-docs').css('left', nsWidth + varWidth + 2)
$('.primary').css('width', primaryWidth)
$('.secondary').css('width', secondaryWidth).css('left', primaryWidth + 1)
if (secondaryWidth > 0) {
$('#content').css('left', primaryWidth + secondaryWidth + 2)
}
else {
$('#content').css('left', primaryWidth + 1)
}
}
$(window).ready(resizeSidebars)
$(window).ready(setCurrentVarLink)
$(window).ready(function() { persistScrollPosition('#namespaces')})
$(window).ready(function() { persistScrollPosition('.primary')})
$(window).ready(function() {
$('#content').scroll(setCurrentVarLink)
$(window).resize(setCurrentVarLink)

2
taoensso.nippy.benchmarks.html
View file

File diff suppressed because one or more lines are too long

18
taoensso.nippy.compression.html
View file

@ -1,8 +1,8 @@
<!DOCTYPE html>
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.compression documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 2.10.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></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 current"><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.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" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ELZ4Compressor"><div class="inner"><span>-&gt;LZ4Compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ELZMA2Compressor"><div class="inner"><span>-&gt;LZMA2Compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ESnappyCompressor"><div class="inner"><span>-&gt;SnappyCompressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-ICompressor"><div class="inner"><span>ICompressor</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.compression.html#var-compress"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>compress</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.compression.html#var-decompress"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>decompress</span></div></a></li><li class="depth-2"><a href="taoensso.nippy.compression.html#var-header-id"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>header-id</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lz4-compressor"><div class="inner"><span>lz4-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lz4hc-compressor"><div class="inner"><span>lz4hc-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lzma2-compressor"><div class="inner"><span>lzma2-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-snappy-compressor"><div class="inner"><span>snappy-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-standard-header-ids"><div class="inner"><span>standard-header-ids</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">taoensso.nippy.compression</h2><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var--.3ELZ4Compressor"><h3>-&gt;LZ4Compressor</h3><div class="usage"><code>(-&gt;LZ4Compressor compressor decompressor)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
</pre></div></div><div class="public anchor" id="var--.3ELZMA2Compressor"><h3>-&gt;LZMA2Compressor</h3><div class="usage"><code>(-&gt;LZMA2Compressor compression-level)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
</pre></div></div><div class="public anchor" id="var--.3ESnappyCompressor"><h3>-&gt;SnappyCompressor</h3><div class="usage"><code>(-&gt;SnappyCompressor)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
</pre></div></div><div class="public anchor" id="var-ICompressor"><h3>ICompressor</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-compress"><h3>compress</h3><div class="usage"><code>(compress compressor ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-decompress"><h3>decompress</h3><div class="usage"><code>(decompress compressor ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-header-id"><h3>header-id</h3><div class="usage"><code>(header-id compressor)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div></div><div class="public anchor" id="var-lz4-compressor"><h3>lz4-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default net.jpountz.lz4 compressor:
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.compression documentation</title></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">2.11.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><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 current"><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.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.compression.html#var--.3ELZ4Compressor"><div class="inner"><span>-&gt;LZ4Compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ELZMA2Compressor"><div class="inner"><span>-&gt;LZMA2Compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var--.3ESnappyCompressor"><div class="inner"><span>-&gt;SnappyCompressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-ICompressor"><div class="inner"><span>ICompressor</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.compression.html#var-compress"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>compress</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.compression.html#var-decompress"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>decompress</span></div></a></li><li class="depth-2"><a href="taoensso.nippy.compression.html#var-header-id"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>header-id</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lz4-compressor"><div class="inner"><span>lz4-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lz4hc-compressor"><div class="inner"><span>lz4hc-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-lzma2-compressor"><div class="inner"><span>lzma2-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-snappy-compressor"><div class="inner"><span>snappy-compressor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.compression.html#var-standard-header-ids"><div class="inner"><span>standard-header-ids</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.nippy.compression</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var--.3ELZ4Compressor"><h3>-&gt;LZ4Compressor</h3><div class="usage"><code>(-&gt;LZ4Compressor compressor decompressor)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L72">view source</a></div></div><div class="public anchor" id="var--.3ELZMA2Compressor"><h3>-&gt;LZMA2Compressor</h3><div class="usage"><code>(-&gt;LZMA2Compressor compression-level)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L33">view source</a></div></div><div class="public anchor" id="var--.3ESnappyCompressor"><h3>-&gt;SnappyCompressor</h3><div class="usage"><code>(-&gt;SnappyCompressor)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L18">view source</a></div></div><div class="public anchor" id="var-ICompressor"><h3>ICompressor</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-compress"><h3>compress</h3><div class="usage"><code>(compress compressor ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-decompress"><h3>decompress</h3><div class="usage"><code>(decompress compressor ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-header-id"><h3>header-id</h3><div class="usage"><code>(header-id compressor)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L9">view source</a></div></div><div class="public anchor" id="var-lz4-compressor"><h3>lz4-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default net.jpountz.lz4 compressor:
Ratio: low.
Write speed: very high.
Read speed: very high.
@ -10,17 +10,17 @@ Write speed: very high.
A good general-purpose compressor, competitive with Snappy.
Thanks to Max Penet (@mpenet) for our first implementation,
Ref. <a href="https://github.com/mpenet/nippy-lz4">https://github.com/mpenet/nippy-lz4</a></pre></div></div><div class="public anchor" id="var-lz4hc-compressor"><h3>lz4hc-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Like `lz4-compressor` but trades some write speed for ratio.
</pre></div></div><div class="public anchor" id="var-lzma2-compressor"><h3>lzma2-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default org.tukaani.xz.LZMA2 compressor:
Ref. <a href="https://github.com/mpenet/nippy-lz4">https://github.com/mpenet/nippy-lz4</a></pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L104">view source</a></div></div><div class="public anchor" id="var-lz4hc-compressor"><h3>lz4hc-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Like `lz4-compressor` but trades some write speed for ratio.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L117">view source</a></div></div><div class="public anchor" id="var-lzma2-compressor"><h3>lzma2-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default org.tukaani.xz.LZMA2 compressor:
Ratio: high.
Write speed: _very_ slow (also currently single-threaded).
Read speed: slow.
A specialized compressor for large, low-write data in space-sensitive
environments.</pre></div></div><div class="public anchor" id="var-snappy-compressor"><h3>snappy-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default org.iq80.snappy.Snappy compressor:
environments.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L62">view source</a></div></div><div class="public anchor" id="var-snappy-compressor"><h3>snappy-compressor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default org.iq80.snappy.Snappy compressor:
Ratio: low.
Write speed: very high.
Read speed: very high.
A good general-purpose compressor.</pre></div></div><div class="public anchor" id="var-standard-header-ids"><h3>standard-header-ids</h3><div class="usage"></div><div class="doc"><pre class="plaintext">These&apos;ll support :auto thaw.
</pre></div></div></div></body></html>
A good general-purpose compressor.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L24">view source</a></div></div><div class="public anchor" id="var-standard-header-ids"><h3>standard-header-ids</h3><div class="usage"></div><div class="doc"><pre class="plaintext">These&apos;ll support :auto thaw.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/compression.clj#L16">view source</a></div></div></div></body></html>

10
taoensso.nippy.encryption.html
View file

@ -1,7 +1,7 @@
<!DOCTYPE html>
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.encryption documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 2.10.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></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 current"><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" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.nippy.encryption.html#var--.3EAES128Encryptor"><div class="inner"><span>-&gt;AES128Encryptor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-aes128-encryptor"><div class="inner"><span>aes128-encryptor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-IEncryptor"><div class="inner"><span>IEncryptor</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.encryption.html#var-decrypt"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>decrypt</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.encryption.html#var-encrypt"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>encrypt</span></div></a></li><li class="depth-2"><a href="taoensso.nippy.encryption.html#var-header-id"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>header-id</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-map-.3EAES128Encryptor"><div class="inner"><span>map-&gt;AES128Encryptor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-standard-header-ids"><div class="inner"><span>standard-header-ids</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">taoensso.nippy.encryption</h2><div class="doc"><pre class="plaintext">Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.encryption documentation</title></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">2.11.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><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 current"><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.encryption.html#var--.3EAES128Encryptor"><div class="inner"><span>-&gt;AES128Encryptor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-aes128-encryptor"><div class="inner"><span>aes128-encryptor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-IEncryptor"><div class="inner"><span>IEncryptor</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.encryption.html#var-decrypt"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>decrypt</span></div></a></li><li class="depth-2 branch"><a href="taoensso.nippy.encryption.html#var-encrypt"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>encrypt</span></div></a></li><li class="depth-2"><a href="taoensso.nippy.encryption.html#var-header-id"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>header-id</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-map-.3EAES128Encryptor"><div class="inner"><span>map-&gt;AES128Encryptor</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.encryption.html#var-standard-header-ids"><div class="inner"><span>standard-header-ids</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.nippy.encryption</h1><div class="doc"><pre class="plaintext">Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
deserves some privacy.</pre></div><div class="public anchor" id="var--.3EAES128Encryptor"><h3>-&gt;AES128Encryptor</h3><div class="usage"><code>(-&gt;AES128Encryptor key-gen key-cache)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
</pre></div></div><div class="public anchor" id="var-aes128-encryptor"><h3>aes128-encryptor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default 128bit AES encryptor with multi-round SHA-512 key-gen.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/encryption.clj#L77">view source</a></div></div><div class="public anchor" id="var-aes128-encryptor"><h3>aes128-encryptor</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Default 128bit AES encryptor with multi-round SHA-512 key-gen.
Password form [:salted &quot;my-password&quot;]
---------------------------------------
@ -34,6 +34,6 @@ CONS: Using a small number of keys for many encrypted items means that if any
compromised.
Faster than `aes128-salted`, and harder to attack any particular key - but
increased danger if a key is somehow compromised.</pre></div></div><div class="public anchor" id="var-IEncryptor"><h3>IEncryptor</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-decrypt"><h3>decrypt</h3><div class="usage"><code>(decrypt encryptor pwd ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-encrypt"><h3>encrypt</h3><div class="usage"><code>(encrypt encryptor pwd ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-header-id"><h3>header-id</h3><div class="usage"><code>(header-id encryptor)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div></div><div class="public anchor" id="var-map-.3EAES128Encryptor"><h3>map-&gt;AES128Encryptor</h3><div class="usage"><code>(map-&gt;AES128Encryptor m__6289__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
</pre></div></div><div class="public anchor" id="var-standard-header-ids"><h3>standard-header-ids</h3><div class="usage"></div><div class="doc"><pre class="plaintext">These&apos;ll support :auto thaw.
</pre></div></div></div></body></html>
increased danger if a key is somehow compromised.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/encryption.clj#L111">view source</a></div></div><div class="public anchor" id="var-IEncryptor"><h3>IEncryptor</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-decrypt"><h3>decrypt</h3><div class="usage"><code>(decrypt encryptor pwd ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-encrypt"><h3>encrypt</h3><div class="usage"><code>(encrypt encryptor pwd ba)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-header-id"><h3>header-id</h3><div class="usage"><code>(header-id encryptor)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/encryption.clj#L11">view source</a></div></div><div class="public anchor" id="var-map-.3EAES128Encryptor"><h3>map-&gt;AES128Encryptor</h3><div class="usage"><code>(map-&gt;AES128Encryptor m__6289__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/encryption.clj#L77">view source</a></div></div><div class="public anchor" id="var-standard-header-ids"><h3>standard-header-ids</h3><div class="usage"></div><div class="doc"><pre class="plaintext">These&apos;ll support :auto thaw.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/encryption.clj#L9">view source</a></div></div></div></body></html>

69
taoensso.nippy.html
View file

File diff suppressed because one or more lines are too long

16
taoensso.nippy.tools.html
View file

@ -1,9 +1,9 @@
<!DOCTYPE html>
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.tools documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 2.10.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></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.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" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><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--.3EWrappedForFreezing"><div class="inner"><span>-&gt;WrappedForFreezing</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-map-.3EWrappedForFreezing"><div class="inner"><span>map-&gt;WrappedForFreezing</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-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"><h2 class="anchor" id="top">taoensso.nippy.tools</h2><div class="doc"><pre class="plaintext">Utilities for third-party tools that want to add fully-user-configurable
Nippy support. Used by Carmine and Faraday.</pre></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--.3EWrappedForFreezing"><h3>-&gt;WrappedForFreezing</h3><div class="usage"><code>(-&gt;WrappedForFreezing value opts)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
</pre></div></div><div class="public anchor" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x &amp; [{:keys [default-opts]}])</code></div><div class="doc"><pre class="plaintext">Like `nippy/freeze` but takes options from special argument wrapper when
present.</pre></div></div><div class="public anchor" id="var-map-.3EWrappedForFreezing"><h3>map-&gt;WrappedForFreezing</h3><div class="usage"><code>(map-&gt;WrappedForFreezing m__6289__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
</pre></div></div><div class="public anchor" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba &amp; [{:keys [default-opts]}])</code></div><div class="doc"><pre class="plaintext">Like `nippy/thaw` but takes options from *thaw-opts* binding.
</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">Evaluates body using given options for any automatic deserialization in
context.</pre></div></div><div class="public anchor" id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><div class="usage"><code>(wrap-for-freezing value &amp; [opts])</code></div><div class="doc"><pre class="plaintext">Wraps arg (any freezable data type) so that (tools/freeze &lt;wrapped-arg&gt;)
will serialize the arg using given options.</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>
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.tools documentation</title></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">2.11.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><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.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-*thaw-opts*"><div class="inner"><span>*thaw-opts*</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.tools.html#var--.3EWrappedForFreezing"><div class="inner"><span>-&gt;WrappedForFreezing</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-map-.3EWrappedForFreezing"><div class="inner"><span>map-&gt;WrappedForFreezing</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-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">Utilities for third-party tools that want to add fully-user-configurable
Nippy support. Used by Carmine and Faraday.</pre></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 class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L25">view source</a></div></div><div class="public anchor" id="var--.3EWrappedForFreezing"><h3>-&gt;WrappedForFreezing</h3><div class="usage"><code>(-&gt;WrappedForFreezing value opts)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L7">view source</a></div></div><div class="public anchor" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x &amp; [{:keys [default-opts]}])</code></div><div class="doc"><pre class="plaintext">Like `nippy/freeze` but takes options from special argument wrapper when
present.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L14">view source</a></div></div><div class="public anchor" id="var-map-.3EWrappedForFreezing"><h3>map-&gt;WrappedForFreezing</h3><div class="usage"><code>(map-&gt;WrappedForFreezing m__6289__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L7">view source</a></div></div><div class="public anchor" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba &amp; [{:keys [default-opts]}])</code></div><div class="doc"><pre class="plaintext">Like `nippy/thaw` but takes options from *thaw-opts* binding.
</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L31">view source</a></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">Evaluates body using given options for any automatic deserialization in
context.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L26">view source</a></div></div><div class="public anchor" id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><div class="usage"><code>(wrap-for-freezing value &amp; [opts])</code></div><div class="doc"><pre class="plaintext">Wraps arg (any freezable data type) so that (tools/freeze &lt;wrapped-arg&gt;)
will serialize the arg using given options.</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L9">view source</a></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 class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/tools.clj#L8">view source</a></div></div></div></body></html>

4
taoensso.nippy.utils.html
View file

@ -1,9 +1,9 @@
<!DOCTYPE html>
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.utils documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 2.10.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></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.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 current"><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" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.nippy.utils.html#var-freezable.3F"><div class="inner"><span>freezable?</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.utils.html#var-readable.3F"><div class="inner"><span>readable?</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.utils.html#var-serializable.3F"><div class="inner"><span>serializable?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">taoensso.nippy.utils</h2><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-freezable.3F"><h3>freezable?</h3><div class="usage"><code>(freezable? x &amp; [{:keys [allow-clojure-reader? allow-java-serializable?]}])</code></div><div class="doc"><pre class="plaintext">Alpha - subject to change, MAY BE BUGGY!
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.utils documentation</title></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">2.11.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><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.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 current"><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.utils.html#var-freezable.3F"><div class="inner"><span>freezable?</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.utils.html#var-readable.3F"><div class="inner"><span>readable?</span></div></a></li><li class="depth-1"><a href="taoensso.nippy.utils.html#var-serializable.3F"><div class="inner"><span>serializable?</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.nippy.utils</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-freezable.3F"><h3>freezable?</h3><div class="usage"><code>(freezable? x &amp; [{:keys [allow-clojure-reader? allow-java-serializable?]}])</code></div><div class="doc"><pre class="plaintext">Alpha - subject to change, MAY BE BUGGY!
Returns truthy value iff Nippy supports de/serialization of given argument.
Conservative with default options.
`:allow-clojure-reader?` and `:allow-java-serializable?` options may be used
to also enable the relevant roundtrip fallback test(s). These tests are only
**moderately reliable** since they&apos;re cached by arg type and don&apos;t test for
pre/post serialization equality (there&apos;s no good general way of doing so).</pre></div></div><div class="public anchor" id="var-readable.3F"><h3>readable?</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-serializable.3F"><h3>serializable?</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div></div></body></html>
pre/post serialization equality (there&apos;s no good general way of doing so).</pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/utils.clj#L79">view source</a></div></div><div class="public anchor" id="var-readable.3F"><h3>readable?</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/utils.clj#L36">view source</a></div></div><div class="public anchor" id="var-serializable.3F"><h3>serializable?</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/ptaoussanis/nippy/blob/master/src/taoensso/nippy/utils.clj#L22">view source</a></div></div></div></body></html>