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

v2.7.0-alpha1

Browse source
This commit is contained in:
Peter Taoussanis 2014-07-06 13:37:03 +07:00
parent 045df61703
commit 788134fba9
10 changed files with 491 additions and 158 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

316
css/default.css
View file

@ -1,17 +1,19 @@
body {
font-family: sans-serif;
font-size: 11pt;
font-family: Helvetica, Arial, sans-serif;
font-size: 15px;
}
pre, code {
font-family: Monaco, DejaVu Sans Mono, Consolas, monospace;
font-size: 9pt;
margin: 15px 0;
}
h2 {
font-weight: normal;
font-size: 18pt;
margin: 10px 0 0.4em 0;
font-size: 28px;
padding: 10px 0 2px 0;
margin: 0;
}
#header, #content, .sidebar {
@ -25,7 +27,7 @@ h2 {
height: 20px;
background: #444;
color: #fff;
padding: 5px;
padding: 5px 7px;
}
#content {
@ -35,7 +37,7 @@ h2 {
overflow: auto;
background: #fff;
color: #333;
padding: 0 1em;
padding: 0 18px;
}
.sidebar {
@ -46,15 +48,15 @@ h2 {
}
#namespaces {
background: #e6e6e6;
border-right: solid 1px #bbb;
background: #e2e2e2;
border-right: solid 1px #cccccc;
left: 0;
width: 250px;
}
#vars {
background: #eeeeee;
border-right: solid 1px #ccc;
background: #f2f2f2;
border-right: solid 1px #cccccc;
left: 251px;
width: 200px;
}
@ -73,7 +75,7 @@ h2 {
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 10px #555;
box-shadow: 0 0 8px rgba(0, 0, 0, 0.4);
z-index: 100;
}
@ -81,7 +83,7 @@ h2 {
margin: 0;
padding: 0;
font-size: 12pt;
font-weight: normal;
font-weight: lighter;
text-shadow: -1px -1px 0px #333;
}
@ -103,6 +105,7 @@ h2 {
font-size: 9pt;
font-weight: normal;
margin: 3px 3px;
padding: 0;
color: #bbb;
}
@ -112,9 +115,9 @@ h2 {
.sidebar h3 {
margin: 0;
padding: 10px 0.5em 0 0.5em;
font-size: 14pt;
font-weight: normal
padding: 10px 10px 0 10px;
font-size: 19px;
font-weight: normal;
}
.sidebar ul {
@ -124,31 +127,88 @@ h2 {
.sidebar li {
display: block;
vertical-align: middle;
}
.sidebar li a {
padding: 7px 10px;
.sidebar li a, .sidebar li .no-link {
border-left: 3px solid transparent;
padding: 0 7px;
white-space: nowrap;
}
.sidebar li .no-link {
display: block;
color: #777;
font-style: italic;
}
.sidebar li .inner {
display: inline-block;
padding-top: 7px;
height: 24px;
}
.sidebar li a, .sidebar li .tree {
height: 31px;
}
.depth-1 .inner { padding-left: 2px; }
.depth-2 .inner { padding-left: 6px; }
.depth-3 .inner { padding-left: 20px; }
.depth-4 .inner { padding-left: 34px; }
.depth-5 .inner { padding-left: 48px; }
.depth-6 .inner { padding-left: 62px; }
.sidebar li .tree {
display: block;
float: left;
position: relative;
top: -10px;
margin: 0 4px 0 0;
padding: 0;
}
.sidebar li.depth-1 .tree {
display: none;
}
.sidebar li .tree .top, .sidebar li .tree .bottom {
display: block;
margin: 0;
padding: 0;
width: 7px;
}
.sidebar li .tree .top {
border-left: 1px solid #aaa;
border-bottom: 1px solid #aaa;
height: 19px;
}
.sidebar li .tree .bottom {
height: 22px;
}
.sidebar li.branch .tree .bottom {
border-left: 1px solid #aaa;
}
#namespaces li.current a {
border-left: 3px solid #a33;
padding-left: 7px;
color: #a33;
}
#vars li.current a {
border-left: 3px solid #33a;
padding-left: 7px;
color: #33a;
}
#content h3 {
margin-bottom: 0.5em;
font-size: 13pt;
font-weight: bold;
}
.public h3, h4.macro {
.public h3 {
margin: 0;
float: left;
}
@ -157,38 +217,122 @@ h2 {
clear: both;
}
h4.macro {
font-variant: small-caps;
font-size: 13px;
font-weight: bold;
color: #717171;
margin-top: 3px;
margin-left: 10px;
}
.public {
margin-top: 1.5em;
margin-bottom: 2.0em;
margin: 0;
border-top: 1px solid #e0e0e0;
padding-top: 14px;
padding-bottom: 6px;
}
.public:last-child {
margin-bottom: 20%;
}
.members .public:last-child {
margin-bottom: 0;
}
.members {
margin: 15px 0;
}
.members h4 {
color: #555;
font-weight: normal;
font-variant: small-caps;
margin: 0 0 5px 0;
}
.members .inner {
padding-top: 5px;
padding-left: 12px;
margin-top: 2px;
margin-left: 7px;
border-left: 1px solid #bbb;
}
#content .members .inner h3 {
font-size: 12pt;
}
.members .public {
border-top: none;
margin-top: 0;
padding-top: 6px;
padding-bottom: 0;
}
.members .public:first-child {
padding-top: 0;
}
h4.type,
h4.dynamic,
h4.added,
h4.deprecated {
float: left;
margin: 3px 10px 15px 0;
font-size: 15px;
font-weight: bold;
font-variant: small-caps;
}
.public h4.type,
.public h4.dynamic,
.public h4.added,
.public h4.deprecated {
font-size: 13px;
font-weight: bold;
margin: 3px 0 0 10px;
}
.members h4.type,
.members h4.added,
.members h4.deprecated {
margin-top: 1px;
}
h4.type {
color: #717171;
}
h4.dynamic {
color: #9933aa;
}
h4.added {
color: #508820;
}
h4.deprecated {
color: #880000;
}
.namespace {
margin-bottom: 30px;
}
.namespace:last-child {
margin-bottom: 10%;
}
.index {
padding: 0;
font-size: 80%;
margin: 15px 0;
line-height: 16px;
}
.index * {
display: inline;
}
.index p {
padding-right: 3px;
}
.index li {
padding: 0 .5em;
padding-right: 5px;
}
.index ul {
@ -198,12 +342,114 @@ h4.macro {
.usage code {
display: block;
color: #008;
margin: 2px 0;
}
.usage code:first-child {
padding-top: 10px;
}
p {
margin: 15px 0;
}
.public p:first-child, .public pre.plaintext {
margin-top: 12px;
}
.doc {
margin-bottom: .5em;
margin: 0 0 26px 0;
clear: both;
}
.public .doc {
margin: 0;
}
.namespace-index .doc {
margin-bottom: 20px;
}
.namespace-index .namespace .doc {
margin-bottom: 10px;
}
.markdown {
line-height: 18px;
font-size: 14px;
}
.doc, .public, .namespace .index {
max-width: 680px;
overflow-x: visible;
}
.markdown code, .src-link a {
background: #f6f6f6;
border: 1px solid #e4e4e4;
border-radius: 2px;
}
.markdown pre {
background: #f4f4f4;
border: 1px solid #e0e0e0;
border-radius: 2px;
padding: 5px 10px;
margin: 0 10px;
}
.markdown pre code {
background: transparent;
border: none;
}
.doc ul, .doc ol {
padding-left: 30px;
}
.doc table {
border-collapse: collapse;
margin: 0 10px;
}
.doc table td, .doc table th {
border: 1px solid #dddddd;
padding: 4px 6px;
}
.doc table th {
background: #f2f2f2;
}
.doc dl {
margin: 0 10px 20px 10px;
}
.doc dl dt {
font-weight: bold;
margin: 0;
padding: 3px 0;
border-bottom: 1px solid #ddd;
}
.doc dl dd {
padding: 5px 0;
margin: 0 0 5px 10px;
}
.doc abbr {
border-bottom: 1px dotted #333;
font-variant: none
cursor: help;
}
.src-link {
margin-bottom: 15px;
}
.src-link a {
font-size: 9pt;
font-size: 70%;
padding: 1px 4px;
text-decoration: none;
color: #5555bb;
}

11
index.html
View file

File diff suppressed because one or more lines are too long

10
js/jquery.min.js vendored
View file

File diff suppressed because one or more lines are too long

52
js/page_effects.js
View file

@ -11,15 +11,35 @@ function findLinkByFragment(elements, fragment) {
return $(elements).filter(function(i, e) { return hasFragment(e, fragment)}).first()
}
function scrollToCurrentVarLink(elements) {
var elements = $(elements);
var parent = elements.offsetParent();
if (elements.length == 0) return;
var top = elements.first().position().top;
var bottom = elements.last().position().top + elements.last().height();
if (top >= 0 && bottom <= parent.height()) return;
if (top < 0) {
parent.scrollTop(parent.scrollTop() + top);
}
else if (bottom > parent.height()) {
parent.scrollTop(parent.scrollTop() + bottom - parent.height());
}
}
function setCurrentVarLink() {
$('#vars li').removeClass('current')
$('.public').
$('#vars a').parent().removeClass('current')
$('.anchor').
filter(function(index) { return visibleInParent(this) }).
each(function(index, element) {
findLinkByFragment("#vars a", element.id).
parent().
addClass('current')
})
});
scrollToCurrentVarLink('#vars .current');
}
var hasStorage = (function() { try { return localStorage.getItem } catch(e) {} }())
@ -47,18 +67,30 @@ function persistScrollPosition(element) {
}
function sidebarContentWidth(element) {
var widths = $(element).find('span').map(function() { return $(this).width() })
var widths = $(element).find('.inner').map(function() { return $(this).innerWidth() })
return Math.max.apply(Math, widths)
}
function resizeNamespaces() {
var width = sidebarContentWidth('#namespaces') + 40
$('#namespaces').css('width', width)
$('#vars, .namespace-index').css('left', width + 1)
$('.namespace-docs').css('left', $('#vars').width() + width + 2)
function resizeSidebars() {
var nsWidth = sidebarContentWidth('#namespaces') + 30
var varWidth = 0
if ($('#vars').length != 0) {
varWidth = sidebarContentWidth('#vars') + 30
}
$(window).ready(resizeNamespaces)
// snap to grid
var snap = 30;
nsWidth = Math.ceil(nsWidth / snap) * snap;
varWidth = Math.ceil(varWidth / snap) * snap;
$('#namespaces').css('width', nsWidth)
$('#vars').css('width', varWidth)
$('#vars, .namespace-index').css('left', nsWidth + 1)
$('.namespace-docs').css('left', nsWidth + varWidth + 2)
}
$(window).ready(resizeSidebars)
$(window).ready(setCurrentVarLink)
$(window).ready(function() { persistScrollPosition('#namespaces')})
$(window).ready(function() {

2
taoensso.nippy.benchmarks.html
View file

@ -1,2 +1,2 @@
<!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.benchmarks 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.6.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li class="current"><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li><a href="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><li><a href="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.benchmarks.html#var-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.benchmarks.html#var-bench*"><span>bench*</span></a></li><li><a href="taoensso.nippy.benchmarks.html#var-bench1"><span>bench1</span></a></li><li><a href="taoensso.nippy.benchmarks.html#var-data"><span>data</span></a></li><li><a href="taoensso.nippy.benchmarks.html#var-fressian-freeze"><span>fressian-freeze</span></a></li><li><a href="taoensso.nippy.benchmarks.html#var-fressian-thaw"><span>fressian-thaw</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.benchmarks documentation</h2><pre class="doc"></pre><div class="public" id="var-bench"><h3>bench</h3><div class="usage"><code>(bench {:keys [reader? lzma2? fressian? laps], :or {laps 1}})</code></div><pre class="doc"></pre></div><div class="public" id="var-bench*"><h3>bench*</h3><h4 class="macro">macro</h4><div class="usage"><code>(bench* &amp; body)</code></div><pre class="doc"></pre></div><div class="public" id="var-bench1"><h3>bench1</h3><div class="usage"><code>(bench1 freezer thawer &amp; [sizer])</code></div><pre class="doc"></pre></div><div class="public" id="var-data"><h3>data</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-fressian-freeze"><h3>fressian-freeze</h3><div class="usage"><code>(fressian-freeze value)</code></div><pre class="doc"></pre></div><div class="public" id="var-fressian-thaw"><h3>fressian-thaw</h3><div class="usage"><code>(fressian-thaw value)</code></div><pre class="doc"></pre></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.benchmarks 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.7.0-alpha1 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 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.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.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"><h2 class="anchor" id="top">taoensso.nippy.benchmarks</h2><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>

32
taoensso.nippy.compression.html
View file

@ -1,16 +1,26 @@
<!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.6.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li class="current"><a href="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li><a href="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><li><a href="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.compression.html#var--%3ELZMA2Compressor"><span>-&gt;LZMA2Compressor</span></a></li><li><a href="taoensso.nippy.compression.html#var--%3ESnappyCompressor"><span>-&gt;SnappyCompressor</span></a></li><li><a href="taoensso.nippy.compression.html#var-ICompressor"><span>ICompressor</span></a></li><li><a href="taoensso.nippy.compression.html#var-compress"><span>compress</span></a></li><li><a href="taoensso.nippy.compression.html#var-decompress"><span>decompress</span></a></li><li><a href="taoensso.nippy.compression.html#var-lzma2-compressor"><span>lzma2-compressor</span></a></li><li><a href="taoensso.nippy.compression.html#var-snappy-compressor"><span>snappy-compressor</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.compression documentation</h2><pre class="doc">Alpha - subject to change.
</pre><div class="public" id="var--%3ELZMA2Compressor"><h3>-&gt;LZMA2Compressor</h3><div class="usage"><code>(-&gt;LZMA2Compressor compression-level)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
</pre></div><div class="public" id="var--%3ESnappyCompressor"><h3>-&gt;SnappyCompressor</h3><div class="usage"><code>(-&gt;SnappyCompressor)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
</pre></div><div class="public" id="var-ICompressor"><h3>ICompressor</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-compress"><h3>compress</h3><div class="usage"><code>(compress compressor ba)</code></div><pre class="doc"></pre></div><div class="public" id="var-decompress"><h3>decompress</h3><div class="usage"><code>(decompress compressor ba)</code></div><pre class="doc"></pre></div><div class="public" id="var-lzma2-compressor"><h3>lzma2-compressor</h3><div class="usage"></div><pre class="doc">Alpha - subject to change.
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.</pre></div><div class="public" id="var-snappy-compressor"><h3>snappy-compressor</h3><div class="usage"></div><pre class="doc">Default org.iq80.snappy.Snappy 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">Nippy 2.7.0-alpha1 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:
Ratio: low.
Write speed: very high.
Read speed: very high.
A good general-purpose compressor for Redis.</pre></div></div></body></html>
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:
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:
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>

17
taoensso.nippy.encryption.html
View file

@ -1,9 +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.6.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li class="current"><a href="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><li><a href="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.encryption.html#var--%3EAES128Encryptor"><span>-&gt;AES128Encryptor</span></a></li><li><a href="taoensso.nippy.encryption.html#var-IEncryptor"><span>IEncryptor</span></a></li><li><a href="taoensso.nippy.encryption.html#var-aes128-encryptor"><span>aes128-encryptor</span></a></li><li><a href="taoensso.nippy.encryption.html#var-decrypt"><span>decrypt</span></a></li><li><a href="taoensso.nippy.encryption.html#var-encrypt"><span>encrypt</span></a></li><li><a href="taoensso.nippy.encryption.html#var-map-%3EAES128Encryptor"><span>map-&gt;AES128Encryptor</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.encryption documentation</h2><pre class="doc">Alpha - subject to change.
Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
deserves some privacy.</pre><div class="public" id="var--%3EAES128Encryptor"><h3>-&gt;AES128Encryptor</h3><div class="usage"><code>(-&gt;AES128Encryptor key-cache)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
</pre></div><div class="public" id="var-IEncryptor"><h3>IEncryptor</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-aes128-encryptor"><h3>aes128-encryptor</h3><div class="usage"></div><pre class="doc">Alpha - subject to change.
Default 128bit AES encryptor with multi-round SHA-512 keygen.
<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.7.0-alpha1 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
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.
Password form [:salted &quot;my-password&quot;]
---------------------------------------
@ -14,7 +12,7 @@ IMPLEMENTATION: Uses a relatively cheap key hash, but automatically salts
every key.
PROS: Each key is independent so would need to be attacked independently.
CONS: Key caching impossible, so there's an inherent trade-off between
CONS: Key caching impossible, so there&apos;s an inherent trade-off between
encryption/decryption speed and the difficulty of attacking any
particular key.
@ -24,7 +22,7 @@ keys are independent.
Password form [:cached &quot;my-password&quot;]
---------------------------------------
USE CASE: You want only a small, finite number of passwords (e.g. a limited
number of staff/admins, or you'll be using a single password to
number of staff/admins, or you&apos;ll be using a single password to
encrypt many items).
IMPLEMENTATION: Uses a _very_ expensive (but cached) key hash, and no salt.
@ -36,5 +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 class="public" id="var-decrypt"><h3>decrypt</h3><div class="usage"><code>(decrypt encryptor pwd ba)</code></div><pre class="doc"></pre></div><div class="public" id="var-encrypt"><h3>encrypt</h3><div class="usage"><code>(encrypt encryptor pwd ba)</code></div><pre class="doc"></pre></div><div class="public" id="var-map-%3EAES128Encryptor"><h3>map-&gt;AES128Encryptor</h3><div class="usage"><code>(map-&gt;AES128Encryptor m__5869__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
</pre></div></div></body></html>
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__5869__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>

133
taoensso.nippy.html
View file

File diff suppressed because one or more lines are too long

20
taoensso.nippy.tools.html
View file

@ -1,13 +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.6.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li><a href="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><li class="current"><a href="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.tools.html#var-*thaw-opts*"><span>*thaw-opts*</span></a></li><li><a href="taoensso.nippy.tools.html#var--%3EEncryptedFrozen"><span>-&gt;EncryptedFrozen</span></a></li><li><a href="taoensso.nippy.tools.html#var--%3EWrappedForFreezing"><span>-&gt;WrappedForFreezing</span></a></li><li><a href="taoensso.nippy.tools.html#var-encrypted-frozen%3F"><span>encrypted-frozen?</span></a></li><li><a href="taoensso.nippy.tools.html#var-freeze"><span>freeze</span></a></li><li><a href="taoensso.nippy.tools.html#var-map-%3EEncryptedFrozen"><span>map-&gt;EncryptedFrozen</span></a></li><li><a href="taoensso.nippy.tools.html#var-map-%3EWrappedForFreezing"><span>map-&gt;WrappedForFreezing</span></a></li><li><a href="taoensso.nippy.tools.html#var-thaw"><span>thaw</span></a></li><li><a href="taoensso.nippy.tools.html#var-with-thaw-opts"><span>with-thaw-opts</span></a></li><li><a href="taoensso.nippy.tools.html#var-wrap-for-freezing"><span>wrap-for-freezing</span></a></li><li><a href="taoensso.nippy.tools.html#var-wrapped-for-freezing%3F"><span>wrapped-for-freezing?</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.tools documentation</h2><pre class="doc">Alpha - subject to change.
Utilities for third-party tools that want to add fully-user-configurable Nippy
support. Used by Carmine and Faraday.</pre><div class="public" id="var-*thaw-opts*"><h3>*thaw-opts*</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var--%3EEncryptedFrozen"><h3>-&gt;EncryptedFrozen</h3><div class="usage"><code>(-&gt;EncryptedFrozen ba)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.tools.EncryptedFrozen.
</pre></div><div class="public" id="var--%3EWrappedForFreezing"><h3>-&gt;WrappedForFreezing</h3><div class="usage"><code>(-&gt;WrappedForFreezing value opts)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
</pre></div><div class="public" id="var-encrypted-frozen%3F"><h3>encrypted-frozen?</h3><div class="usage"><code>(encrypted-frozen? x)</code></div><pre class="doc"></pre></div><div class="public" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x &amp; [{:keys [default-opts]}])</code></div><pre class="doc">Like `nippy/freeze` but takes options from special argument wrapper when
present.</pre></div><div class="public" id="var-map-%3EEncryptedFrozen"><h3>map-&gt;EncryptedFrozen</h3><div class="usage"><code>(map-&gt;EncryptedFrozen m__5869__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.tools.EncryptedFrozen, taking a map of keywords to field values.
</pre></div><div class="public" id="var-map-%3EWrappedForFreezing"><h3>map-&gt;WrappedForFreezing</h3><div class="usage"><code>(map-&gt;WrappedForFreezing m__5869__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
</pre></div><div class="public" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba &amp; [{:keys [default-opts]}])</code></div><pre class="doc">Like `nippy/thaw` but takes options from *thaw-opts* binding, and wraps
encrypted bytes for easy identification when no password has been provided
for decryption.</pre></div><div class="public" id="var-with-thaw-opts"><h3>with-thaw-opts</h3><h4 class="macro">macro</h4><div class="usage"><code>(with-thaw-opts opts &amp; body)</code></div><pre class="doc">Evaluates body using given options for any automatic deserialization in
context.</pre></div><div class="public" id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><div class="usage"><code>(wrap-for-freezing value &amp; [opts])</code></div><pre class="doc">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="public" id="var-wrapped-for-freezing%3F"><h3>wrapped-for-freezing?</h3><div class="usage"><code>(wrapped-for-freezing? x)</code></div><pre class="doc"></pre></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">Nippy 2.7.0-alpha1 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__5869__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>

6
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.6.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li><a href="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><li><a href="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></li><li class="current"><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.utils.html#var-freezable%3F"><span>freezable?</span></a></li><li><a href="taoensso.nippy.utils.html#var-readable%3F"><span>readable?</span></a></li><li><a href="taoensso.nippy.utils.html#var-serializable%3F"><span>serializable?</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.utils documentation</h2><pre class="doc"></pre><div class="public" id="var-freezable%3F"><h3>freezable?</h3><div class="usage"><code>(freezable? x &amp; [{:keys [allow-clojure-reader? allow-java-serializable?]}])</code></div><pre class="doc">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">Nippy 2.7.0-alpha1 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!
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're cached by arg type and don't test for
pre/post serialization equality (there's no good general way of doing so).</pre></div><div class="public" id="var-readable%3F"><h3>readable?</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-serializable%3F"><h3>serializable?</h3><div class="usage"></div><pre class="doc"></pre></div></div></body></html>
**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>