Nippy 2.12.0-RC2
High-performance serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "2.12.0-RC2"]
Namespaces
taoensso.nippy
High-performance serialization library for Clojure
Public variables and functions:
- *auto-freeze-compressor*
- *custom-readers*
- *final-freeze-fallback*
- *freeze-fallback*
- ->CacheWrapped
- ->StressRecord
- -cache-proxy
- aes128-encryptor
- cache
- compress
- decompress
- decrypt
- encrypt
- extend-freeze
- extend-thaw
- fast-freeze
- fast-thaw
- freezable?
- freeze
- freeze-fallback-as-str
- freeze-to-out!
- IFreezable1
- IFreezable2
- inspect-ba
- lz4-compressor
- lz4hc-compressor
- lzma2-compressor
- map->StressRecord
- set-auto-freeze-compressor!
- set-freeze-fallback!
- snappy-compressor
- stress-data
- stress-data-benchable
- stress-data-comparable
- swap-custom-readers!
- thaw
- thaw-from-in!
- throw-unfreezable
- try-write-readable
- try-write-serializable
- write-id
- write-unfreezable
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults
Public variables and functions:
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support. +Nippy 2.12.0 Generated by Codox
Nippy 2.12.0
\ No newline at end of file diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index 4ec6fbb..5fe6ae3 100644 --- a/taoensso.nippy.benchmarks.html +++ b/taoensso.nippy.benchmarks.html @@ -1,3 +1,3 @@ -Nippy 2.12.0
High-performance serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "2.12.0"]Namespaces
taoensso.nippy
High-performance serialization library for ClojurePublic variables and functions:
- *auto-freeze-compressor*
- *custom-readers*
- *final-freeze-fallback*
- *freeze-fallback*
- ->CacheWrapped
- ->StressRecord
- -cache-proxy
- aes128-encryptor
- cache
- compress
- decompress
- decrypt
- encrypt
- extend-freeze
- extend-thaw
- fast-freeze
- fast-thaw
- freezable?
- freeze
- freeze-to-out!
- IFreezable1
- IFreezable2
- inspect-ba
- lz4-compressor
- lz4hc-compressor
- lzma2-compressor
- map->StressRecord
- set-auto-freeze-compressor!
- set-freeze-fallback!
- snappy-compressor
- stress-data
- stress-data-benchable
- stress-data-comparable
- swap-custom-readers!
- thaw
- thaw-from-in!
- throw-unfreezable
- try-write-readable
- try-write-serializable
- write-id
- write-unfreezable
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaultsPublic variables and functions:
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support. Used by Carmine, Faraday, etc.Public variables and functions:
taoensso.nippy.benchmarks documentation Generated by Codox
Nippy 2.12.0-RC2
\ No newline at end of file +taoensso.nippy.benchmarks
taoensso.nippy.benchmarks documentation Generated by Codox
Nippy 2.12.0
\ No newline at end of file diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html index c3a069e..db64775 100644 --- a/taoensso.nippy.compression.html +++ b/taoensso.nippy.compression.html @@ -1,6 +1,6 @@ -taoensso.nippy.benchmarks
taoensso.nippy.compression documentation Generated by Codox
Nippy 2.12.0-RC2
taoensso.nippy.compression
->LZ4Compressor
(->LZ4Compressor compressor decompressor)Positional factory function for class taoensso.nippy.compression.LZ4Compressor. +taoensso.nippy.compression documentation Generated by Codox
Nippy 2.12.0
taoensso.nippy.compression
->LZ4Compressor
(->LZ4Compressor compressor decompressor)Positional factory function for class taoensso.nippy.compression.LZ4Compressor.->LZMA2Compressor
(->LZMA2Compressor compression-level)Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.->SnappyCompressor
(->SnappyCompressor)Positional factory function for class taoensso.nippy.compression.SnappyCompressor.ICompressor
protocol
members
compress
(compress compressor ba)decompress
(decompress compressor ba)header-id
(header-id compressor)lz4-compressor
Default net.jpountz.lz4 compressor: diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html index f787ea8..1449304 100644 --- a/taoensso.nippy.encryption.html +++ b/taoensso.nippy.encryption.html @@ -1,6 +1,6 @@ -taoensso.nippy.encryption documentation Generated by Codox
Nippy 2.12.0-RC2
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults +taoensso.nippy.encryption documentation Generated by Codox
Nippy 2.12.0
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults->AES128Encryptor
(->AES128Encryptor header-id keyfn cached-keyfn)Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.aes128-encryptor
Default 128bit AES encryptor with many-round SHA-512 key-gen. diff --git a/taoensso.nippy.html b/taoensso.nippy.html index 9b3b51c..9bcd1bb 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,10 +1,9 @@ -taoensso.nippy documentation Generated by Codox
Nippy 2.12.0-RC2
taoensso.nippy
High-performance serialization library for Clojure +taoensso.nippy documentation Generated by Codox
Nippy 2.12.0
taoensso.nippy
High-performance serialization library for Clojure*auto-freeze-compressor*
dynamic
(fn [byte-array])->compressor used by `(freeze <x> {:compressor :auto}), nil => default->CacheWrapped
(->CacheWrapped val)Positional factory function for class taoensso.nippy.CacheWrapped.->StressRecord
(->StressRecord data)Positional factory function for class taoensso.nippy.StressRecord.-cache-proxy
{[<x> <meta>] <idx>} for freezing, {<idx> <x-with-meta>} for thawing. @@ -83,8 +82,7 @@ used to 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 value equality (there's no good general way of doing so).freeze
(freeze x)(freeze x {:keys [compressor encryptor password], :or {compressor :auto, encryptor aes128-encryptor}, :as opts})Serializes arg (any Clojure data type) to a byte array. To freeze custom -types, extend the Clojure reader or see `extend-freeze`.freeze-to-out!
(freeze-to-out! data-output x)Serializes arg (any Clojure data type) to a DataOutput. +types, extend the Clojure reader or see `extend-freeze`.freeze-to-out!
(freeze-to-out! data-output x)Serializes arg (any Clojure data type) to a DataOutput. This is a low-level util: in most cases you'll want `freeze` instead.lz4-compressor
Default net.jpountz.lz4 compressor: Ratio: low. diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html index 0a2000b..f71753b 100644 --- a/taoensso.nippy.tools.html +++ b/taoensso.nippy.tools.html @@ -1,6 +1,6 @@ -taoensso.nippy.tools documentation Generated by Codox
Nippy 2.12.0-RC2
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support. +taoensso.nippy.tools documentation Generated by Codox
Nippy 2.12.0
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support. Used by Carmine, Faraday, etc.->WrappedForFreezing
(->WrappedForFreezing val opts)Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.freeze
(freeze x)(freeze x default-opts)Like `nippy/freeze` but merges opts from *freeze-opts*, `wrap-for-freezing`.thaw
(thaw ba)(thaw ba default-opts)Like `nippy/thaw` but merges opts from `*thaw-opts*`. diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html index e9dae1f..9ee7992 100644 --- a/taoensso.nippy.utils.html +++ b/taoensso.nippy.utils.html @@ -1,10 +1,10 @@ -taoensso.nippy.utils documentation Generated by Codox
Nippy 2.12.0-RC2
\ No newline at end of filetaoensso.nippy.utils
freezable?
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})Alpha - subject to change. +taoensso.nippy.utils documentation Generated by Codox
Nippy 2.12.0
\ No newline at end of file +way of doing so).taoensso.nippy.utils
freezable?
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})Alpha - subject to change. Returns truthy iff Nippy *appears* to support freezing the given argument. `:allow-clojure-reader?` and `:allow-java-serializable?` options may be used to 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 value equality (there's no good general -way of doing so).