Nippy 3.0.0-RC3
Released under the Eclipse Public License
High-performance serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "3.0.0-RC3"]
Namespaces
taoensso.nippy
High-performance serialization library for Clojure
Public variables and functions:
- *auto-freeze-compressor*
- *custom-readers*
- *final-freeze-fallback*
- *freeze-fallback*
- *freeze-serializable-allowlist*
- *incl-metadata?*
- *thaw-serializable-allowlist*
- -cache-proxy
- aes128-cbc-encryptor
- aes128-encryptor
- aes128-gcm-encryptor
- allow-and-record-any-serializable-class-unsafe
- cache
- compress
- decompress
- decrypt
- default-freeze-serializable-allowlist
- default-thaw-serializable-allowlist
- encrypt
- extend-freeze
- extend-thaw
- fast-freeze
- fast-thaw
- freezable?
- freeze
- freeze-to-file
- freeze-to-out!
- freeze-to-string
- get-recorded-serializable-classes
- IFreezable1
- IFreezable2
- inspect-ba
- lz4-compressor
- lz4hc-compressor
- lzma2-compressor
- read-quarantined-serializable-object-unsafe!
- snappy-compressor
- stress-data
- stress-data-benchable
- stress-data-comparable
- thaw
- thaw-from-file
- thaw-from-in!
- thaw-from-string
- throw-unfreezable
- try-write-readable
- try-write-serializable
- write-id
- write-unfreezable
taoensso.nippy.crypto
Low-level crypto utils. +Nippy 3.0.0 Generated by Codox
Nippy 3.0.0
\ No newline at end of file diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index be4cdec..52a8cb8 100644 --- a/taoensso.nippy.benchmarks.html +++ b/taoensso.nippy.benchmarks.html @@ -1,3 +1,3 @@ -Nippy 3.0.0
Released under the Eclipse Public License
High-performance serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "3.0.0"]Namespaces
taoensso.nippy
High-performance serialization library for ClojurePublic variables and functions:
- *auto-freeze-compressor*
- *custom-readers*
- *final-freeze-fallback*
- *freeze-fallback*
- *freeze-serializable-allowlist*
- *incl-metadata?*
- *serializable-whitelist*
- *thaw-serializable-allowlist*
- -cache-proxy
- aes128-cbc-encryptor
- aes128-encryptor
- aes128-gcm-encryptor
- allow-and-record-any-serializable-class-unsafe
- cache
- compress
- decompress
- decrypt
- default-freeze-serializable-allowlist
- default-thaw-serializable-allowlist
- encrypt
- extend-freeze
- extend-thaw
- fast-freeze
- fast-thaw
- freezable?
- freeze
- freeze-to-file
- freeze-to-out!
- freeze-to-string
- get-recorded-serializable-classes
- IFreezable1
- IFreezable2
- inspect-ba
- lz4-compressor
- lz4hc-compressor
- lzma2-compressor
- read-quarantined-serializable-object-unsafe!
- snappy-compressor
- stress-data
- stress-data-benchable
- stress-data-comparable
- thaw
- thaw-from-file
- thaw-from-in!
- thaw-from-string
- throw-unfreezable
- try-write-readable
- try-write-serializable
- write-id
- write-unfreezable
taoensso.nippy.crypto
Low-level crypto utils. Private & alpha, very likely to change!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 3.0.0-RC3
\ No newline at end of file +taoensso.nippy.benchmarks
bench
(bench {:keys [reader? lzma2? fressian? laps], :or {laps 1}})bench*
macro
(bench* & body)bench1
(bench1 freezer thawer & [sizer])data
fressian-freeze
(fressian-freeze value)fressian-thaw
(fressian-thaw value)taoensso.nippy.benchmarks documentation Generated by Codox
Nippy 3.0.0
\ No newline at end of file diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html index 4a27b19..c5bbb20 100644 --- a/taoensso.nippy.compression.html +++ b/taoensso.nippy.compression.html @@ -1,6 +1,6 @@ -taoensso.nippy.benchmarks
bench
(bench {:keys [reader? lzma2? fressian? laps], :or {laps 1}})bench*
macro
(bench* & body)bench1
(bench1 freezer thawer & [sizer])data
fressian-freeze
(fressian-freeze value)fressian-thaw
(fressian-thaw value)taoensso.nippy.compression documentation Generated by Codox
Nippy 3.0.0-RC3
taoensso.nippy.compression
ICompressor
protocol
members
compress
(compress compressor ba)decompress
(decompress compressor ba)header-id
(header-id compressor)lz4-compressor
Default net.jpountz.lz4 compressor: +taoensso.nippy.compression documentation Generated by Codox
Nippy 3.0.0
taoensso.nippy.compression
ICompressor
protocol
members
compress
(compress compressor ba)decompress
(decompress compressor ba)header-id
(header-id compressor)lz4-compressor
Default net.jpountz.lz4 compressor: Ratio: low. Write speed: very high. Read speed: very high. diff --git a/taoensso.nippy.crypto.html b/taoensso.nippy.crypto.html index 6679921..8b7ac36 100644 --- a/taoensso.nippy.crypto.html +++ b/taoensso.nippy.crypto.html @@ -1,6 +1,6 @@ -taoensso.nippy.crypto documentation Generated by Codox
Nippy 3.0.0-RC3
taoensso.nippy.crypto
Low-level crypto utils. +taoensso.nippy.crypto documentation Generated by Codox
Nippy 3.0.0
taoensso.nippy.crypto
Low-level crypto utils. Private & alpha, very likely to change!cbc-cipher
(cbc-cipher)cipher-kit-aes-cbc
Default CipherKit for AES CBCcipher-kit-aes-gcm
Default CipherKit for AES GCMdecrypt
(decrypt {:keys [cipher-kit salt-size salt->key-fn enc-ba], :or {cipher-kit cipher-kit-aes-gcm}})encrypt
(encrypt {:keys [cipher-kit ?salt-ba key-ba plain-ba rand-bytes-fn], :or {cipher-kit cipher-kit-aes-gcm, rand-bytes-fn rand-bytes}})gcm-cipher
(gcm-cipher)ICipherKit
protocol
members
get-cipher
(get-cipher _)Returns a thread-safe `javax.crypto.Cipher` instance. diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html index 5044515..dde3aef 100644 --- a/taoensso.nippy.encryption.html +++ b/taoensso.nippy.encryption.html @@ -1,6 +1,6 @@ -taoensso.nippy.encryption documentation Generated by Codox
Nippy 3.0.0-RC3
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults +taoensso.nippy.encryption documentation Generated by Codox
Nippy 3.0.0
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaultsaes128-cbc-encryptor
Default 128bit AES-CBC encryptor with many-round SHA-512 key-gen. See also `aes-128-cbc-encryptor`.aes128-gcm-encryptor
Default 128bit AES-GCM encryptor with many-round SHA-512 key-gen. diff --git a/taoensso.nippy.html b/taoensso.nippy.html index 6b7e7ca..6935e5b 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,6 +1,6 @@ -taoensso.nippy documentation Generated by Codox
Nippy 3.0.0-RC3
taoensso.nippy
High-performance serialization library for Clojure +taoensso.nippy documentation Generated by Codox
Nippy 3.0.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*custom-readers*
dynamic
{<hash-or-byte-id> (fn [data-input])->read}*final-freeze-fallback*
dynamic
DEPRECATED: prefer `*freeze-fallback`. @@ -70,6 +70,7 @@ identifying this vulnerability. [1] https://github.com/ptaoussanis/nippy/issues/130 [2] See `allow-and-record-any-serializable-class-unsafe`.*incl-metadata?*
dynamic
Include metadata when freezing/thawing? +*serializable-whitelist*
dynamic
DEPRECATED, now called `*thaw-serializable-allowlist*`*thaw-serializable-allowlist*
dynamic
Used when attempting to <freeze/thaw> an object that: - Does NOT implement Nippy's Freezable protocol. - DOES implement Java's Serializable interface. diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html index adf6422..7dfec63 100644 --- a/taoensso.nippy.tools.html +++ b/taoensso.nippy.tools.html @@ -1,6 +1,6 @@ -taoensso.nippy.tools documentation Generated by Codox
Nippy 3.0.0-RC3
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support. +taoensso.nippy.tools documentation Generated by Codox
Nippy 3.0.0
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support. Used by Carmine, Faraday, etc.*freeze-opts*
dynamic
*thaw-opts*
dynamic
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*`.with-freeze-opts
macro
(with-freeze-opts opts & body)with-thaw-opts
macro
(with-thaw-opts opts & body)wrap-for-freezing
(wrap-for-freezing x)(wrap-for-freezing x opts)Ensures that given arg (any freezable data type) is wrapped so that diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html index a630496..4a0a680 100644 --- a/taoensso.nippy.utils.html +++ b/taoensso.nippy.utils.html @@ -1,6 +1,6 @@ -taoensso.nippy.utils documentation Generated by Codox
Nippy 3.0.0-RC3
taoensso.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 3.0.0
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