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 Clojure
Public 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. +Nippy 3.1.0 Generated by Codox
Nippy 3.1.0
\ No newline at end of file diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index 52a8cb8..bd1f6ef 100644 --- a/taoensso.nippy.benchmarks.html +++ b/taoensso.nippy.benchmarks.html @@ -1,3 +1,3 @@ -Nippy 3.1.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.1.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-resource
- 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
\ 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.1.0
\ No newline at end of file diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html index c5bbb20..b3bcf44 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
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.1.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 8b7ac36..ffd9b15 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
taoensso.nippy.crypto
Low-level crypto utils. +taoensso.nippy.crypto documentation Generated by Codox
Nippy 3.1.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 dde3aef..799dee0 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
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults +taoensso.nippy.encryption documentation Generated by Codox
Nippy 3.1.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 6935e5b..8afef3b 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,6 +1,6 @@ -taoensso.nippy documentation Generated by Codox
Nippy 3.0.0
taoensso.nippy
High-performance serialization library for Clojure +taoensso.nippy documentation Generated by Codox
Nippy 3.1.0
\ No newline at end of file diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html index 7dfec63..542d1ff 100644 --- a/taoensso.nippy.tools.html +++ b/taoensso.nippy.tools.html @@ -1,6 +1,6 @@ -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`. @@ -278,9 +278,8 @@ 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 {:as opts, :keys [compressor encryptor password serializable-allowlist incl-metadata?], :or {compressor :auto, encryptor aes128-gcm-encryptor}})Serializes arg (any Clojure data type) to a byte array. To freeze custom -types, extend the Clojure reader or see `extend-freeze`.freeze-to-file
(freeze-to-file file x)(freeze-to-file file x freeze-opts)Convenience util: like `freeze`, but writes to `(clojure.java.io/file <file>)` -and returns the byte array written. -See also `thaw-from-file`.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-file
(freeze-to-file file x)(freeze-to-file file x freeze-opts)Convenience util: like `freeze`, but writes to `(clojure.java.io/file <file>)`. +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.freeze-to-string
(freeze-to-string x)(freeze-to-string x freeze-opts)Convenience util: like `freeze`, but returns a Base64-encoded string. See also `thaw-from-string`.get-recorded-serializable-classes
(get-recorded-serializable-classes)Returns {<class-name> <frequency>} of the <=1000 classes that ~most frequently made use of Nippy's Serializable support via @@ -328,12 +327,9 @@ Options include: :v1-compatibility? - support data frozen by legacy versions of Nippy? :compressor - :auto (checks header, default) an ICompressor, or nil :encryptor - :auto (checks header, default), an IEncryptor, or nilthaw-from-file
(thaw-from-file file)(thaw-from-file file thaw-opts)Convenience util: like `thaw`, but reads from `(clojure.java.io/file <file>)`. - -To thaw from a resource on classpath (e.g in Leiningen `resources` dir): - (thaw-from-file (clojure.java.io/resource "my-resource-name.npy")) - -See also `freeze-to-file`.thaw-from-in!
(thaw-from-in! data-input)Deserializes a frozen object from given DataInput to its original Clojure +thaw-from-in!
(thaw-from-in! data-input)Deserializes a frozen object from given DataInput to its original Clojure data type. -This is a low-level util: in most cases you'll want `thaw` instead.thaw-from-string
(thaw-from-string s)(thaw-from-string s thaw-opts)Convenience util: like `thaw`, but takes a Base64-encoded string. +This is a low-level util: in most cases you'll want `thaw` instead.thaw-from-resource
(thaw-from-resource res)(thaw-from-resource res thaw-opts)Convenience util: like `thaw`, but reads from `(clojure.java.io/resource <res>)`. +thaw-from-string
(thaw-from-string s)(thaw-from-string s thaw-opts)Convenience util: like `thaw`, but takes a Base64-encoded string. See also `freeze-to-string`.throw-unfreezable
(throw-unfreezable x)try-write-readable
(try-write-readable out x)try-write-serializable
(try-write-serializable out x)write-id
macro
(write-id out id)write-unfreezable
(write-unfreezable out x)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. +taoensso.nippy.tools documentation Generated by Codox
Nippy 3.1.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 4a0a680..f575e7a 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
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.1.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