RC1
This commit is contained in:
Peter Taoussanis
parent
82e68621c4
commit
3230736f24
7 changed files with 23 additions and 8 deletions
|
|
@ -1,6 +1,8 @@
|
|||
<!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 2.0.0-alpha7 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-alpha7 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-alpha7 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
|
||||
<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-RC1 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-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><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-RC1 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
|
||||
from Deep-Freeze.</pre><div class="index"><p>Public variables and functions:</p><ul><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--%3ESnappyCompressor"><span>->SnappyCompressor</span></a></li><li><a href="taoensso.nippy.compression.html#var-snappy-compressor"><span>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
|
||||
deserves some privacy.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.encryption.html#var--%3EAES128Encryptor"><span>->AES128Encryptor</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-map-%3EAES128Encryptor"><span>map->AES128Encryptor</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>
|
||||
deserves some privacy.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.encryption.html#var--%3EAES128Encryptor"><span>->AES128Encryptor</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-map-%3EAES128Encryptor"><span>map->AES128Encryptor</span></a></li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></h3><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="index"><p>Public variables and functions:</p><ul><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-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></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>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!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 2.0.0-alpha7 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>
|
||||
<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-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></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.benchmarks documentation</h2><pre class="doc"></pre></div></body></html>
|
||||
|
|
@ -1,5 +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-alpha7 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--%3ESnappyCompressor"><span>->SnappyCompressor</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><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-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--%3ESnappyCompressor"><span>->SnappyCompressor</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--%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-snappy-compressor"><h3>snappy-compressor</h3><div class="usage"></div><pre class="doc">Default org.iq80.snappy.Snappy compressor.
|
||||
</pre></div></div></body></html>
|
||||
|
|
@ -1,5 +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.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-alpha7 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--%3EAES128Encryptor"><span>->AES128Encryptor</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-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><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-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-aes128-encryptor"><span>aes128-encryptor</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
|
||||
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-aes128-encryptor"><h3>aes128-encryptor</h3><div class="usage"></div><pre class="doc">Alpha - subject to change.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
<!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 2.0.0-alpha7 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-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
|
||||
<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-RC1 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.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.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
|
||||
from Deep-Freeze.</pre><div class="public" id="var-freeze"><h3>freeze</h3><div class="usage"><code>(freeze x & [{:keys [print-dup? password compressor encryptor legacy-mode], :or {print-dup? true, compressor snappy-compressor, encryptor aes128-encryptor}}])</code></div><pre class="doc">Serializes arg (any Clojure data type) to a byte array. Set :legacy-mode to
|
||||
true to produce bytes readble by Nippy < 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 & {:keys [print-dup? compress?], :or {print-dup? true, compress? true}})</code></div><pre class="doc">DEPRECATED: Use `freeze` instead.
|
||||
</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 & benchmarks.
|
||||
</pre></div><div class="public" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba & [{:keys [read-eval? password compressor encryptor legacy-opts], :or {legacy-opts {:compressed? true}, compressor snappy-compressor, encryptor aes128-encryptor}}])</code></div><pre class="doc">Deserializes frozen bytes to their original Clojure data type. Supports data
|
||||
</pre></div><div class="public" id="var-thaw"><h3>thaw</h3><div class="usage"><code>(thaw ba & [{:keys [read-eval? password compressor encryptor legacy-opts], :or {legacy-opts {:compressed? true}, compressor snappy-compressor, encryptor aes128-encryptor}, :as opts}])</code></div><pre class="doc">Deserializes frozen bytes to their original Clojure data type. Supports data
|
||||
frozen with current and all previous versions of Nippy.
|
||||
|
||||
WARNING: Enabling `:read-eval?` can lead to security vulnerabilities unless
|
||||
|
|
|
|||
13
taoensso.nippy.tools.html
Normal file
13
taoensso.nippy.tools.html
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<!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.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.0.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--%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-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></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--%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-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.
|
||||
</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-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
|
||||
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
|
||||
context.</pre></div><div class="public" id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><div class="usage"><code>(wrap-for-freezing value & [opts])</code></div><pre class="doc">Wraps arg (any freezable data type) so that (tools/freeze <wrapped-arg>)
|
||||
will serialize the arg using given options.</pre></div></div></body></html>
|
||||
|
|
@ -1,5 +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.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-alpha7 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 & {:keys [warmup-laps num-threads as-ns?]})</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-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-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 & {: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 & 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 & 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-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.
|
||||
|
|
|
|||
Loading…
Reference in a new issue