4 lines
No EOL
15 KiB
HTML
4 lines
No EOL
15 KiB
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>Nippy 2.11.0-RC1</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Nippy</span> <span class="project-version">2.11.0-RC1</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.nippy.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>nippy</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.benchmarks.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>benchmarks</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.compression.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>compression</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.encryption.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>encryption</span></div></a></li><li class="depth-3 branch"><a href="taoensso.nippy.tools.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools</span></div></a></li><li class="depth-3"><a href="taoensso.nippy.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Nippy</span> <span class="project-version">2.11.0-RC1</span></span></h1><div class="doc"><p>High-performance serialization library for Clojure</p></div><h2>Installation</h2><p>To install, add the following dependency to your project file:</p><pre class="deps">[com.taoensso/nippy "2.11.0-RC1"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="taoensso.nippy.html">taoensso.nippy</a></h3><div class="doc"><pre class="plaintext">High-performance serialization library for Clojure.
|
|
Originally adapted from Deep-Freeze (Ref. <a href="https://goo.gl/OePPGr)">https://goo.gl/OePPGr)</a>.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.nippy.html#var-*custom-readers*">*custom-readers*</a> </li><li> <a href="taoensso.nippy.html#var-*default-freeze-compressor-selector*">*default-freeze-compressor-selector*</a> </li><li> <a href="taoensso.nippy.html#var-*final-freeze-fallback*">*final-freeze-fallback*</a> </li><li> <a href="taoensso.nippy.html#var--.3ECompressable-LZMA2">->Compressable-LZMA2</a> </li><li> <a href="taoensso.nippy.html#var--.3EStressRecord">->StressRecord</a> </li><li> <a href="taoensso.nippy.html#var-aes128-encryptor">aes128-encryptor</a> </li><li> <a href="taoensso.nippy.html#var-byte-sized.3F">byte-sized?</a> </li><li> <a href="taoensso.nippy.html#var-compress">compress</a> </li><li> <a href="taoensso.nippy.html#var-decompress">decompress</a> </li><li> <a href="taoensso.nippy.html#var-decrypt">decrypt</a> </li><li> <a href="taoensso.nippy.html#var-default-freeze-compressor-selector">default-freeze-compressor-selector</a> </li><li> <a href="taoensso.nippy.html#var-encrypt">encrypt</a> </li><li> <a href="taoensso.nippy.html#var-extend-freeze">extend-freeze</a> </li><li> <a href="taoensso.nippy.html#var-extend-thaw">extend-thaw</a> </li><li> <a href="taoensso.nippy.html#var-Freezable">Freezable</a> </li><li> <a href="taoensso.nippy.html#var-freezable.3F">freezable?</a> </li><li> <a href="taoensso.nippy.html#var-freeze">freeze</a> </li><li> <a href="taoensso.nippy.html#var-freeze-fallback-as-str">freeze-fallback-as-str</a> </li><li> <a href="taoensso.nippy.html#var-freeze-to-out.21">freeze-to-out!</a> </li><li> <a href="taoensso.nippy.html#var-id-bigdec">id-bigdec</a> </li><li> <a href="taoensso.nippy.html#var-id-bigint">id-bigint</a> </li><li> <a href="taoensso.nippy.html#var-id-biginteger">id-biginteger</a> </li><li> <a href="taoensso.nippy.html#var-id-boolean">id-boolean</a> </li><li> <a href="taoensso.nippy.html#var-id-byte">id-byte</a> </li><li> <a href="taoensso.nippy.html#var-id-byte-as-long">id-byte-as-long</a> </li><li> <a href="taoensso.nippy.html#var-id-bytes">id-bytes</a> </li><li> <a href="taoensso.nippy.html#var-id-char">id-char</a> </li><li> <a href="taoensso.nippy.html#var-id-date">id-date</a> </li><li> <a href="taoensso.nippy.html#var-id-double">id-double</a> </li><li> <a href="taoensso.nippy.html#var-id-float">id-float</a> </li><li> <a href="taoensso.nippy.html#var-id-int-as-long">id-int-as-long</a> </li><li> <a href="taoensso.nippy.html#var-id-integer">id-integer</a> </li><li> <a href="taoensso.nippy.html#var-id-keyword">id-keyword</a> </li><li> <a href="taoensso.nippy.html#var-id-keyword-depr1">id-keyword-depr1</a> </li><li> <a href="taoensso.nippy.html#var-id-list">id-list</a> </li><li> <a href="taoensso.nippy.html#var-id-long">id-long</a> </li><li> <a href="taoensso.nippy.html#var-id-map">id-map</a> </li><li> <a href="taoensso.nippy.html#var-id-map-depr1">id-map-depr1</a> </li><li> <a href="taoensso.nippy.html#var-id-map-depr2">id-map-depr2</a> </li><li> <a href="taoensso.nippy.html#var-id-meta">id-meta</a> </li><li> <a href="taoensso.nippy.html#var-id-nil">id-nil</a> </li><li> <a href="taoensso.nippy.html#var-id-prefixed-custom">id-prefixed-custom</a> </li><li> <a href="taoensso.nippy.html#var-id-queue">id-queue</a> </li><li> <a href="taoensso.nippy.html#var-id-ratio">id-ratio</a> </li><li> <a href="taoensso.nippy.html#var-id-reader">id-reader</a> </li><li> <a href="taoensso.nippy.html#var-id-reader-depr1">id-reader-depr1</a> </li><li> <a href="taoensso.nippy.html#var-id-record">id-record</a> </li><li> <a href="taoensso.nippy.html#var-id-reserved">id-reserved</a> </li><li> <a href="taoensso.nippy.html#var-id-seq">id-seq</a> </li><li> <a href="taoensso.nippy.html#var-id-serializable">id-serializable</a> </li><li> <a href="taoensso.nippy.html#var-id-set">id-set</a> </li><li> <a href="taoensso.nippy.html#var-id-short">id-short</a> </li><li> <a href="taoensso.nippy.html#var-id-short-as-long">id-short-as-long</a> </li><li> <a href="taoensso.nippy.html#var-id-sm-bytes">id-sm-bytes</a> </li><li> <a href="taoensso.nippy.html#var-id-sm-keyword">id-sm-keyword</a> </li><li> <a href="taoensso.nippy.html#var-id-sm-map">id-sm-map</a> </li><li> <a href="taoensso.nippy.html#var-id-sm-set">id-sm-set</a> </li><li> <a href="taoensso.nippy.html#var-id-sm-string">id-sm-string</a> </li><li> <a href="taoensso.nippy.html#var-id-sm-vec">id-sm-vec</a> </li><li> <a href="taoensso.nippy.html#var-id-sorted-map">id-sorted-map</a> </li><li> <a href="taoensso.nippy.html#var-id-sorted-map-depr1">id-sorted-map-depr1</a> </li><li> <a href="taoensso.nippy.html#var-id-sorted-set">id-sorted-set</a> </li><li> <a href="taoensso.nippy.html#var-id-string">id-string</a> </li><li> <a href="taoensso.nippy.html#var-id-string-depr1">id-string-depr1</a> </li><li> <a href="taoensso.nippy.html#var-id-uuid">id-uuid</a> </li><li> <a href="taoensso.nippy.html#var-id-vec">id-vec</a> </li><li> <a href="taoensso.nippy.html#var-inspect-ba">inspect-ba</a> </li><li> <a href="taoensso.nippy.html#var-lz4-compressor">lz4-compressor</a> </li><li> <a href="taoensso.nippy.html#var-lz4hc-compressor">lz4hc-compressor</a> </li><li> <a href="taoensso.nippy.html#var-lzma2-compressor">lzma2-compressor</a> </li><li> <a href="taoensso.nippy.html#var-map-.3ECompressable-LZMA2">map->Compressable-LZMA2</a> </li><li> <a href="taoensso.nippy.html#var-map-.3EStressRecord">map->StressRecord</a> </li><li> <a href="taoensso.nippy.html#var-read-biginteger">read-biginteger</a> </li><li> <a href="taoensso.nippy.html#var-read-bytes">read-bytes</a> </li><li> <a href="taoensso.nippy.html#var-read-coll">read-coll</a> </li><li> <a href="taoensso.nippy.html#var-read-kvs">read-kvs</a> </li><li> <a href="taoensso.nippy.html#var-read-kvs-depr1">read-kvs-depr1</a> </li><li> <a href="taoensso.nippy.html#var-read-sm-bytes">read-sm-bytes</a> </li><li> <a href="taoensso.nippy.html#var-read-sm-coll">read-sm-coll</a> </li><li> <a href="taoensso.nippy.html#var-read-sm-kvs">read-sm-kvs</a> </li><li> <a href="taoensso.nippy.html#var-read-sm-utf8">read-sm-utf8</a> </li><li> <a href="taoensso.nippy.html#var-read-utf8">read-utf8</a> </li><li> <a href="taoensso.nippy.html#var-set-default-freeze-compressor-selector.21">set-default-freeze-compressor-selector!</a> </li><li> <a href="taoensso.nippy.html#var-short-sized.3F">short-sized?</a> </li><li> <a href="taoensso.nippy.html#var-snappy-compressor">snappy-compressor</a> </li><li> <a href="taoensso.nippy.html#var-stress-data">stress-data</a> </li><li> <a href="taoensso.nippy.html#var-stress-data-benchable">stress-data-benchable</a> </li><li> <a href="taoensso.nippy.html#var-stress-data-comparable">stress-data-comparable</a> </li><li> <a href="taoensso.nippy.html#var-swap-custom-readers.21">swap-custom-readers!</a> </li><li> <a href="taoensso.nippy.html#var-thaw">thaw</a> </li><li> <a href="taoensso.nippy.html#var-thaw-from-in.21">thaw-from-in!</a> </li><li> <a href="taoensso.nippy.html#var-when-debug">when-debug</a> </li><li> <a href="taoensso.nippy.html#var-write-biginteger">write-biginteger</a> </li><li> <a href="taoensso.nippy.html#var-write-bytes">write-bytes</a> </li><li> <a href="taoensso.nippy.html#var-write-id">write-id</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-bytes">write-ided-bytes</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-coll">write-ided-coll</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-keyword">write-ided-keyword</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-kvs">write-ided-kvs</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-long">write-ided-long</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-map">write-ided-map</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-set">write-ided-set</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-string">write-ided-string</a> </li><li> <a href="taoensso.nippy.html#var-write-ided-vec">write-ided-vec</a> </li><li> <a href="taoensso.nippy.html#var-write-sm-bytes">write-sm-bytes</a> </li><li> <a href="taoensso.nippy.html#var-write-sm-utf8">write-sm-utf8</a> </li><li> <a href="taoensso.nippy.html#var-write-utf8">write-utf8</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.benchmarks.html">taoensso.nippy.benchmarks</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.nippy.benchmarks.html#var-bench">bench</a> </li><li> <a href="taoensso.nippy.benchmarks.html#var-bench*">bench*</a> </li><li> <a href="taoensso.nippy.benchmarks.html#var-bench1">bench1</a> </li><li> <a href="taoensso.nippy.benchmarks.html#var-data">data</a> </li><li> <a href="taoensso.nippy.benchmarks.html#var-fressian-freeze">fressian-freeze</a> </li><li> <a href="taoensso.nippy.benchmarks.html#var-fressian-thaw">fressian-thaw</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.compression.html">taoensso.nippy.compression</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.nippy.compression.html#var--.3ELZ4Compressor">->LZ4Compressor</a> </li><li> <a href="taoensso.nippy.compression.html#var--.3ELZMA2Compressor">->LZMA2Compressor</a> </li><li> <a href="taoensso.nippy.compression.html#var--.3ESnappyCompressor">->SnappyCompressor</a> </li><li> <a href="taoensso.nippy.compression.html#var-ICompressor">ICompressor</a> </li><li> <a href="taoensso.nippy.compression.html#var-lz4-compressor">lz4-compressor</a> </li><li> <a href="taoensso.nippy.compression.html#var-lz4hc-compressor">lz4hc-compressor</a> </li><li> <a href="taoensso.nippy.compression.html#var-lzma2-compressor">lzma2-compressor</a> </li><li> <a href="taoensso.nippy.compression.html#var-snappy-compressor">snappy-compressor</a> </li><li> <a href="taoensso.nippy.compression.html#var-standard-header-ids">standard-header-ids</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.encryption.html">taoensso.nippy.encryption</a></h3><div class="doc"><pre class="plaintext">Simple no-nonsense crypto with reasonable defaults.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.nippy.encryption.html#var--.3EAES128Encryptor">->AES128Encryptor</a> </li><li> <a href="taoensso.nippy.encryption.html#var-aes128-encryptor">aes128-encryptor</a> </li><li> <a href="taoensso.nippy.encryption.html#var-IEncryptor">IEncryptor</a> </li><li> <a href="taoensso.nippy.encryption.html#var-map-.3EAES128Encryptor">map->AES128Encryptor</a> </li><li> <a href="taoensso.nippy.encryption.html#var-standard-header-ids">standard-header-ids</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.tools.html">taoensso.nippy.tools</a></h3><div class="doc"><pre class="plaintext">Utilities for third-party tools that want to add fully-user-configurable
|
|
Nippy support. Used by Carmine and Faraday.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.nippy.tools.html#var-*thaw-opts*">*thaw-opts*</a> </li><li> <a href="taoensso.nippy.tools.html#var--.3EWrappedForFreezing">->WrappedForFreezing</a> </li><li> <a href="taoensso.nippy.tools.html#var-freeze">freeze</a> </li><li> <a href="taoensso.nippy.tools.html#var-map-.3EWrappedForFreezing">map->WrappedForFreezing</a> </li><li> <a href="taoensso.nippy.tools.html#var-thaw">thaw</a> </li><li> <a href="taoensso.nippy.tools.html#var-with-thaw-opts">with-thaw-opts</a> </li><li> <a href="taoensso.nippy.tools.html#var-wrap-for-freezing">wrap-for-freezing</a> </li><li> <a href="taoensso.nippy.tools.html#var-wrapped-for-freezing.3F">wrapped-for-freezing?</a> </li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.utils.html">taoensso.nippy.utils</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="taoensso.nippy.utils.html#var-freezable.3F">freezable?</a> </li><li> <a href="taoensso.nippy.utils.html#var-readable.3F">readable?</a> </li><li> <a href="taoensso.nippy.utils.html#var-serializable.3F">serializable?</a> </li></ul></div></div></div></body></html> |