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

Update (2.0.0-alpha1)

Browse source
This commit is contained in:
Peter Taoussanis 2013-06-13 16:49:09 +07:00
parent fee1665dde
commit 7d6427aa95
6 changed files with 62 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
index.html
View file

@ -1,5 +1,6 @@
<!DOCTYPE html> <!DOCTYPE html>
<html><head><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>Nippy 1.3.0-alpha2 API 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 1.3.0-alpha2 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.crypto.html"><span>taoensso.nippy.crypto</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="namespace-index" id="content"><h2>Nippy 1.3.0-alpha2 API documentation</h2><div class="doc">Clojure serialization library</div><div class="namespace"><h3><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></h3><pre class="doc">Simple, high-performance Clojure serialization library. Adapted from <html><head><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>Nippy 2.0.0-alpha1 API 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.0.0-alpha1 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.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="namespace-index" id="content"><h2>Nippy 2.0.0-alpha1 API documentation</h2><div class="doc">Clojure serialization library</div><div class="namespace"><h3><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></h3><pre class="doc">Simple, high-performance Clojure serialization library. Originally adapted
Deep-Freeze.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.html#var-coll-freezer"><span>coll-freezer</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw%21"><span>coll-thaw!</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw-kvs%21"><span>coll-thaw-kvs!</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-stream%21"><span>freeze-to-stream!</span></a></li><li><a href="taoensso.nippy.html#var-freezer"><span>freezer</span></a></li><li><a href="taoensso.nippy.html#var-kv-freezer"><span>kv-freezer</span></a></li><li><a href="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-stream%21"><span>thaw-from-stream!</span></a></li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.crypto.html"><span>taoensso.nippy.crypto</span></a></h3><pre class="doc">Alpha - subject to change. from Deep-Freeze.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.html#var-coll-thaw"><span>coll-thaw</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw-kvs"><span>coll-thaw-kvs</span></a></li><li><a href="taoensso.nippy.html#var-freeze"><span>freeze</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><a href="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><a href="taoensso.nippy.html#var-thaw"><span>thaw</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></h3><pre class="doc">Alpha - subject to change.
</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.compression.html#var--%3EDefaultSnappyCompressor"><span>-&gt;DefaultSnappyCompressor</span></a></li><li><a href="taoensso.nippy.compression.html#var-default-snappy-compressor"><span>default-snappy-compressor</span></a></li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></h3><pre class="doc">Alpha - subject to change.
Simple no-nonsense crypto with reasonable defaults. Because your Clojure data Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
deserves some privacy.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.crypto.html#var-aes128-cached"><span>aes128-cached</span></a></li><li><a href="taoensso.nippy.crypto.html#var-aes128-salted"><span>aes128-salted</span></a></li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.utils.html#var-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.utils.html#var-case-eval"><span>case-eval</span></a></li><li><a href="taoensso.nippy.utils.html#var-memoized"><span>memoized</span></a></li><li><a href="taoensso.nippy.utils.html#var-pairs"><span>pairs</span></a></li><li><a href="taoensso.nippy.utils.html#var-time-ns"><span>time-ns</span></a></li><li><a href="taoensso.nippy.utils.html#var-version-compare"><span>version-compare</span></a></li></ul></div></div></div></body></html> deserves some privacy.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.encryption.html#var--%3EDefaultAES128Encryptor"><span>-&gt;DefaultAES128Encryptor</span></a></li><li><a href="taoensso.nippy.encryption.html#var-default-aes128-encryptor"><span>default-aes128-encryptor</span></a></li><li><a href="taoensso.nippy.encryption.html#var-map-%3EDefaultAES128Encryptor"><span>map-&gt;DefaultAES128Encryptor</span></a></li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.utils.html#var-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.utils.html#var-case-eval"><span>case-eval</span></a></li><li><a href="taoensso.nippy.utils.html#var-memoized"><span>memoized</span></a></li><li><a href="taoensso.nippy.utils.html#var-repeatedly-into"><span>repeatedly-into</span></a></li><li><a href="taoensso.nippy.utils.html#var-time-ns"><span>time-ns</span></a></li><li><a href="taoensso.nippy.utils.html#var-version-compare"><span>version-compare</span></a></li></ul></div></div></div></body></html>

2
taoensso.nippy.benchmarks.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html><head><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 1.3.0-alpha2 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.crypto.html"><span>taoensso.nippy.crypto</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></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.benchmarks documentation</h2><pre class="doc"></pre></div></body></html> <html><head><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.0.0-alpha1 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.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.benchmarks documentation</h2><pre class="doc"></pre></div></body></html>

5
taoensso.nippy.compression.html Normal file
View file

@ -0,0 +1,5 @@
<!DOCTYPE html>
<html><head><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.0.0-alpha1 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.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--%3EDefaultSnappyCompressor"><span>-&gt;DefaultSnappyCompressor</span></a></li><li><a href="taoensso.nippy.compression.html#var-default-snappy-compressor"><span>default-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--%3EDefaultSnappyCompressor"><h3>-&gt;DefaultSnappyCompressor</h3><div class="usage"><code>(-&gt;DefaultSnappyCompressor)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.compression.DefaultSnappyCompressor.
</pre></div><div class="public" id="var-default-snappy-compressor"><h3>default-snappy-compressor</h3><div class="usage"></div><pre class="doc">Default org.iq80.snappy.Snappy compressor.
</pre></div></div></body></html>

40
taoensso.nippy.encryption.html Normal file
View file

@ -0,0 +1,40 @@
<!DOCTYPE html>
<html><head><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.0.0-alpha1 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.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--%3EDefaultAES128Encryptor"><span>-&gt;DefaultAES128Encryptor</span></a></li><li><a href="taoensso.nippy.encryption.html#var-default-aes128-encryptor"><span>default-aes128-encryptor</span></a></li><li><a href="taoensso.nippy.encryption.html#var-map-%3EDefaultAES128Encryptor"><span>map-&gt;DefaultAES128Encryptor</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--%3EDefaultAES128Encryptor"><h3>-&gt;DefaultAES128Encryptor</h3><div class="usage"><code>(-&gt;DefaultAES128Encryptor key-cache)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.encryption.DefaultAES128Encryptor.
</pre></div><div class="public" id="var-default-aes128-encryptor"><h3>default-aes128-encryptor</h3><div class="usage"></div><pre class="doc">Alpha - subject to change.
Default 128bit AES encryptor with multi-round SHA-512 keygen.
Password form [:salted &quot;my-password&quot;]
---------------------------------------
USE CASE: You want more than a small, finite number of passwords (e.g. each
item encrypted will use a unique user-provided password).
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
encryption/decryption speed and the difficulty of attacking any
particular key.
Slower than `aes128-cached`, and easier to attack any particular key - but
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
encrypt many items).
IMPLEMENTATION: Uses a _very_ expensive (but cached) key hash, and no salt.
PROS: Great amortized encryption/decryption speed. Expensive key hash makes
attacking any particular key very difficult.
CONS: Using a small number of keys for many encrypted items means that if any
key _is_ somehow compromised, _all_ items encrypted with that key are
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-map-%3EDefaultAES128Encryptor"><h3>map-&gt;DefaultAES128Encryptor</h3><div class="usage"><code>(map-&gt;DefaultAES128Encryptor m__5665__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.encryption.DefaultAES128Encryptor, taking a map of keywords to field values.
</pre></div></div></body></html>

20
taoensso.nippy.html
View file

@ -1,13 +1,13 @@
<!DOCTYPE html> <!DOCTYPE html>
<html><head><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 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 1.3.0-alpha2 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li class="current"><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.crypto.html"><span>taoensso.nippy.crypto</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.html#var-coll-freezer"><span>coll-freezer</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw%21"><span>coll-thaw!</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw-kvs%21"><span>coll-thaw-kvs!</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-stream%21"><span>freeze-to-stream!</span></a></li><li><a href="taoensso.nippy.html#var-freezer"><span>freezer</span></a></li><li><a href="taoensso.nippy.html#var-kv-freezer"><span>kv-freezer</span></a></li><li><a href="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-stream%21"><span>thaw-from-stream!</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy documentation</h2><pre class="doc">Simple, high-performance Clojure serialization library. Adapted from <html><head><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 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.0.0-alpha1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li class="current"><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.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.html#var-coll-thaw"><span>coll-thaw</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw-kvs"><span>coll-thaw-kvs</span></a></li><li><a href="taoensso.nippy.html#var-freeze"><span>freeze</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><a href="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><a href="taoensso.nippy.html#var-thaw"><span>thaw</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy documentation</h2><pre class="doc">Simple, high-performance Clojure serialization library. Originally adapted
Deep-Freeze.</pre><div class="public" id="var-coll-freezer"><h3>coll-freezer</h3><h4 class="macro">macro</h4><div class="usage"><code>(coll-freezer type id &amp; body)</code></div><pre class="doc">Extends Freezable to simple collection types. from Deep-Freeze.</pre><div class="public" id="var-coll-thaw"><h3>coll-thaw</h3><div class="usage"><code>(coll-thaw coll s)</code></div><pre class="doc">Thaws simple collection types.
</pre></div><div class="public" id="var-coll-thaw%21"><h3>coll-thaw!</h3><div class="usage"><code>(coll-thaw! s)</code></div><pre class="doc">Thaws simple collection types. </pre></div><div class="public" id="var-coll-thaw-kvs"><h3>coll-thaw-kvs</h3><div class="usage"><code>(coll-thaw-kvs coll s)</code></div><pre class="doc">Thaws key-value collection types.
</pre></div><div class="public" id="var-coll-thaw-kvs%21"><h3>coll-thaw-kvs!</h3><div class="usage"><code>(coll-thaw-kvs! s)</code></div><pre class="doc">Thaws key-value collection types. </pre></div><div class="public" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x &amp; [{:keys [print-dup? password compressor encryptor legacy-mode?], :or {print-dup? true, compressor compression/default-snappy-compressor, encryptor encryption/default-aes128-encryptor}}])</code></div><pre class="doc">Serializes arg (any Clojure data type) to a byte array. Enable
</pre></div><div class="public" id="var-freeze-to-bytes"><h3>freeze-to-bytes</h3><div class="usage"><code>(freeze-to-bytes x &amp; {:keys [compress? print-dup? password], :or {compress? true, print-dup? true}})</code></div><pre class="doc">Serializes x to a byte array and returns the array. `:legacy-mode?` flag to produce bytes readable by Nippy &lt; 2.x.</pre></div><div class="public" id="var-freeze-to-bytes"><h3>freeze-to-bytes</h3><div class="usage"><code>(freeze-to-bytes x &amp; {:keys [print-dup? compress? password], :or {print-dup? true, compress? true}})</code></div><pre class="doc">DEPRECATED: Use `freeze` instead.
</pre></div><div class="public" id="var-freeze-to-stream%21"><h3>freeze-to-stream!</h3><div class="usage"><code>(freeze-to-stream! data-output-stream x)</code><code>(freeze-to-stream! data-output-stream x print-dup?)</code></div><pre class="doc">Serializes x to given output stream.
</pre></div><div class="public" id="var-freezer"><h3>freezer</h3><h4 class="macro">macro</h4><div class="usage"><code>(freezer type id &amp; body)</code></div><pre class="doc">Helper to extend Freezable protocol.
</pre></div><div class="public" id="var-kv-freezer"><h3>kv-freezer</h3><h4 class="macro">macro</h4><div class="usage"><code>(kv-freezer type id &amp; body)</code></div><pre class="doc">Extends Freezable to key-value collection types.
</pre></div><div class="public" id="var-stress-data"><h3>stress-data</h3><div class="usage"></div><pre class="doc">Reference data used for tests &amp; benchmarks. </pre></div><div class="public" id="var-stress-data"><h3>stress-data</h3><div class="usage"></div><pre class="doc">Reference data used for tests &amp; benchmarks.
</pre></div><div class="public" id="var-thaw-from-bytes"><h3>thaw-from-bytes</h3><div class="usage"><code>(thaw-from-bytes ba &amp; {:keys [compressed? read-eval? password], :or {compressed? true, read-eval? false}})</code></div><pre class="doc">Deserializes an object from given byte array. </pre></div><div class="public" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba &amp; [{:keys [read-eval? password compressor encryptor legacy-mode? strict?], :or {compressor compression/default-snappy-compressor, encryptor encryption/default-aes128-encryptor}}])</code></div><pre class="doc">Deserializes frozen bytes to their original Clojure data type. Enable
</pre></div><div class="public" id="var-thaw-from-stream%21"><h3>thaw-from-stream!</h3><div class="usage"><code>(thaw-from-stream! data-input-stream read-eval?)</code></div><pre class="doc">Deserializes an object from given input stream. `:legacy-mode?` to read bytes written by Nippy &lt; 2.x.
WARNING: Enabling `:read-eval?` can lead to security vulnerabilities unless
you are sure you know what you're doing.</pre></div><div class="public" id="var-thaw-from-bytes"><h3>thaw-from-bytes</h3><div class="usage"><code>(thaw-from-bytes ba &amp; {:keys [read-eval? compressed? password], :or {compressed? true}})</code></div><pre class="doc">DEPRECATED: Use `thaw` instead.
</pre></div></div></body></html> </pre></div></div></body></html>

4
taoensso.nippy.utils.html
View file

@ -1,8 +1,8 @@
<!DOCTYPE html> <!DOCTYPE html>
<html><head><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 1.3.0-alpha2 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.crypto.html"><span>taoensso.nippy.crypto</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-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.utils.html#var-case-eval"><span>case-eval</span></a></li><li><a href="taoensso.nippy.utils.html#var-memoized"><span>memoized</span></a></li><li><a href="taoensso.nippy.utils.html#var-pairs"><span>pairs</span></a></li><li><a href="taoensso.nippy.utils.html#var-time-ns"><span>time-ns</span></a></li><li><a href="taoensso.nippy.utils.html#var-version-compare"><span>version-compare</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-bench"><h3>bench</h3><h4 class="macro">macro</h4><div class="usage"><code>(bench num-laps form &amp; {:keys [warmup-laps num-threads as-ms?], :or {as-ms? true}})</code></div><pre class="doc">Repeatedly executes form and returns time taken to complete execution. <html><head><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.0.0-alpha1 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.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-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.utils.html#var-case-eval"><span>case-eval</span></a></li><li><a href="taoensso.nippy.utils.html#var-memoized"><span>memoized</span></a></li><li><a href="taoensso.nippy.utils.html#var-repeatedly-into"><span>repeatedly-into</span></a></li><li><a href="taoensso.nippy.utils.html#var-time-ns"><span>time-ns</span></a></li><li><a href="taoensso.nippy.utils.html#var-version-compare"><span>version-compare</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-bench"><h3>bench</h3><h4 class="macro">macro</h4><div class="usage"><code>(bench num-laps form &amp; {:keys [warmup-laps num-threads as-ns?]})</code></div><pre class="doc">Repeatedly executes form and returns time taken to complete execution.
</pre></div><div class="public" id="var-case-eval"><h3>case-eval</h3><h4 class="macro">macro</h4><div class="usage"><code>(case-eval e &amp; clauses)</code></div><pre class="doc">Like `case` but evaluates test constants for their compile-time value. </pre></div><div class="public" id="var-case-eval"><h3>case-eval</h3><h4 class="macro">macro</h4><div class="usage"><code>(case-eval e &amp; clauses)</code></div><pre class="doc">Like `case` but evaluates test constants for their compile-time value.
</pre></div><div class="public" id="var-memoized"><h3>memoized</h3><div class="usage"><code>(memoized cache f &amp; args)</code></div><pre class="doc">Like `memoize` but takes an explicit cache atom (possibly nil) and </pre></div><div class="public" id="var-memoized"><h3>memoized</h3><div class="usage"><code>(memoized cache f &amp; args)</code></div><pre class="doc">Like `memoize` but takes an explicit cache atom (possibly nil) and
immediately applies memoized f to given arguments.</pre></div><div class="public" id="var-pairs"><h3>pairs</h3><div class="usage"><code>(pairs coll)</code></div><pre class="doc">Like (partition 2 coll) but faster and returns lazy seq of vector pairs. immediately applies memoized f to given arguments.</pre></div><div class="public" id="var-repeatedly-into"><h3>repeatedly-into</h3><div class="usage"><code>(repeatedly-into coll n f)</code></div><pre class="doc">Like `repeatedly` but faster and `conj`s items into given collection.
</pre></div><div class="public" id="var-time-ns"><h3>time-ns</h3><h4 class="macro">macro</h4><div class="usage"><code>(time-ns &amp; body)</code></div><pre class="doc">Returns number of nanoseconds it takes to execute body. </pre></div><div class="public" id="var-time-ns"><h3>time-ns</h3><h4 class="macro">macro</h4><div class="usage"><code>(time-ns &amp; body)</code></div><pre class="doc">Returns number of nanoseconds it takes to execute body.
</pre></div><div class="public" id="var-version-compare"><h3>version-compare</h3><div class="usage"><code>(version-compare x y)</code></div><pre class="doc">Comparator for version strings like x.y.z, etc. </pre></div><div class="public" id="var-version-compare"><h3>version-compare</h3><div class="usage"><code>(version-compare x y)</code></div><pre class="doc">Comparator for version strings like x.y.z, etc.
</pre></div></div></body></html> </pre></div></div></body></html>