v2.6.0-RC1
This commit is contained in:
Peter Taoussanis
parent
d72032ec50
commit
b4c58ae5cb
7 changed files with 33 additions and 22 deletions
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
||||||
<!DOCTYPE html>
|
<!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-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.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* & body)</code></div><pre class="doc"></pre></div><div class="public" id="var-bench1"><h3>bench1</h3><div class="usage"><code>(bench1 freezer thawer & [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.6.0-RC1 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* & body)</code></div><pre class="doc"></pre></div><div class="public" id="var-bench1"><h3>bench1</h3><div class="usage"><code>(bench1 freezer thawer & [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>
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
<!DOCTYPE html>
|
<!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-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.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>->LZMA2Compressor</span></a></li><li><a href="taoensso.nippy.compression.html#var--%3ESnappyCompressor"><span>->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.
|
<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-RC1 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>->LZMA2Compressor</span></a></li><li><a href="taoensso.nippy.compression.html#var--%3ESnappyCompressor"><span>->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>->LZMA2Compressor</h3><div class="usage"><code>(->LZMA2Compressor compression-level)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
|
</pre><div class="public" id="var--%3ELZMA2Compressor"><h3>->LZMA2Compressor</h3><div class="usage"><code>(->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>->SnappyCompressor</h3><div class="usage"><code>(->SnappyCompressor)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
|
</pre></div><div class="public" id="var--%3ESnappyCompressor"><h3>->SnappyCompressor</h3><div class="usage"><code>(->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.
|
</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.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
<!DOCTYPE html>
|
<!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-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.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>->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->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.
|
<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-RC1 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>->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->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
|
Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
|
||||||
deserves some privacy.</pre><div class="public" id="var--%3EAES128Encryptor"><h3>->AES128Encryptor</h3><div class="usage"><code>(->AES128Encryptor key-cache)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
|
deserves some privacy.</pre><div class="public" id="var--%3EAES128Encryptor"><h3>->AES128Encryptor</h3><div class="usage"><code>(->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.
|
</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.
|
||||||
|
|
@ -36,5 +36,5 @@ CONS: Using a small number of keys for many encrypted items means that if any
|
||||||
compromised.
|
compromised.
|
||||||
|
|
||||||
Faster than `aes128-salted`, and harder to attack any particular key - but
|
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->AES128Encryptor</h3><div class="usage"><code>(map->AES128Encryptor m__5665__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
|
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->AES128Encryptor</h3><div class="usage"><code>(map->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>
|
</pre></div></div></body></html>
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -1,11 +1,11 @@
|
||||||
<!DOCTYPE html>
|
<!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-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.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>->EncryptedFrozen</span></a></li><li><a href="taoensso.nippy.tools.html#var--%3EWrappedForFreezing"><span>->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->EncryptedFrozen</span></a></li><li><a href="taoensso.nippy.tools.html#var-map-%3EWrappedForFreezing"><span>map->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.
|
<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-RC1 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>->EncryptedFrozen</span></a></li><li><a href="taoensso.nippy.tools.html#var--%3EWrappedForFreezing"><span>->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->EncryptedFrozen</span></a></li><li><a href="taoensso.nippy.tools.html#var-map-%3EWrappedForFreezing"><span>map->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
|
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>->EncryptedFrozen</h3><div class="usage"><code>(->EncryptedFrozen ba)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.tools.EncryptedFrozen.
|
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>->EncryptedFrozen</h3><div class="usage"><code>(->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>->WrappedForFreezing</h3><div class="usage"><code>(->WrappedForFreezing value opts)</code></div><pre class="doc">Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
|
</pre></div><div class="public" id="var--%3EWrappedForFreezing"><h3>->WrappedForFreezing</h3><div class="usage"><code>(->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 & [{:keys [default-opts]}])</code></div><pre class="doc">Like `nippy/freeze` but takes options from special argument wrapper when
|
</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 & [{: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->EncryptedFrozen</h3><div class="usage"><code>(map->EncryptedFrozen m__5665__auto__)</code></div><pre class="doc">Factory function for class taoensso.nippy.tools.EncryptedFrozen, taking a map of keywords to field values.
|
present.</pre></div><div class="public" id="var-map-%3EEncryptedFrozen"><h3>map->EncryptedFrozen</h3><div class="usage"><code>(map->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->WrappedForFreezing</h3><div class="usage"><code>(map->WrappedForFreezing m__5665__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-map-%3EWrappedForFreezing"><h3>map->WrappedForFreezing</h3><div class="usage"><code>(map->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 & [{:keys [default-opts]}])</code></div><pre class="doc">Like `nippy/thaw` but takes options from *thaw-opts* binding, and wraps
|
</pre></div><div class="public" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba & [{: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
|
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 & body)</code></div><pre class="doc">Evaluates body using given options for any automatic deserialization in
|
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 & body)</code></div><pre class="doc">Evaluates body using given options for any automatic deserialization in
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,9 @@
|
||||||
<!DOCTYPE html>
|
<!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-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.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-ba-concat"><span>ba-concat</span></a></li><li><a href="taoensso.nippy.utils.html#var-ba-split"><span>ba-split</span></a></li><li><a href="taoensso.nippy.utils.html#var-ba%3D"><span>ba=</span></a></li><li><a href="taoensso.nippy.utils.html#var-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.utils.html#var-bytes-class"><span>bytes-class</span></a></li><li><a href="taoensso.nippy.utils.html#var-bytes%3F"><span>bytes?</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-readable%3F"><span>readable?</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-serializable%3F"><span>serializable?</span></a></li><li><a href="taoensso.nippy.utils.html#var-time-ns"><span>time-ns</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-ba-concat"><h3>ba-concat</h3><div class="usage"><code>(ba-concat ba1 ba2)</code></div><pre class="doc"></pre></div><div class="public" id="var-ba-split"><h3>ba-split</h3><div class="usage"><code>(ba-split ba idx)</code></div><pre class="doc"></pre></div><div class="public" id="var-ba%3D"><h3>ba=</h3><div class="usage"><code>(ba= x y)</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 nlaps {:keys [nlaps-warmup nthreads as-ns?], :or {nlaps-warmup 0, nthreads 1}} & body)</code></div><pre class="doc">Repeatedly executes body and returns time taken to complete execution.
|
<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-RC1 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 & [{:keys [allow-clojure-reader? allow-java-serializable?]}])</code></div><pre class="doc">Alpha - subject to change, may be buggy!
|
||||||
</pre></div><div class="public" id="var-bytes-class"><h3>bytes-class</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-bytes%3F"><h3>bytes?</h3><div class="usage"><code>(bytes? x)</code></div><pre class="doc"></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 & clauses)</code></div><pre class="doc">Like `case` but evaluates test constants for their compile-time value.
|
Returns truthy value iff Nippy supports de/serialization of given argument.
|
||||||
</pre></div><div class="public" id="var-memoized"><h3>memoized</h3><div class="usage"><code>(memoized cache f & args)</code></div><pre class="doc">Like `(partial memoize* {})` but takes an explicit cache atom (possibly nil)
|
Conservative with default options.
|
||||||
and immediately applies memoized f to given arguments.</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-repeatedly-into"><h3>repeatedly-into</h3><h4 class="macro">macro</h4><div class="usage"><code>(repeatedly-into coll n & body)</code></div><pre class="doc">Like `repeatedly` but faster and `conj`s items into given collection.
|
|
||||||
</pre></div><div class="public" id="var-serializable%3F"><h3>serializable?</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-time-ns"><h3>time-ns</h3><h4 class="macro">macro</h4><div class="usage"><code>(time-ns & body)</code></div><pre class="doc">Returns number of nanoseconds it takes to execute body.
|
`:allow-clojure-reader?` and `:allow-java-serializable?` options may be used
|
||||||
</pre></div></div></body></html>
|
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>
|
||||||
Loading…
Reference in a new issue