Nippy 3.4.0-RC1
Released under the Eclipse Public License - v 1.0
The fastest serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "3.4.0-RC1"]
Namespaces
taoensso.nippy
High-performance serialization library for Clojure.
Public variables and functions:
- *auto-freeze-compressor*
- *custom-readers*
- *freeze-fallback*
- *freeze-serializable-allowlist*
- *incl-metadata?*
- *thaw-serializable-allowlist*
- *thaw-xform*
- -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
- IFreezable
- IFreezableWithMeta
- inspect-ba
- lz4-compressor
- lz4hc-compressor
- lzma2-compressor
- public-types-spec
- read-quarantined-serializable-object-unsafe!
- stress-data
- 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
- zstd-compressor
taoensso.nippy.tools
Utils for community tools that want to add user-configurable Nippy support. +Nippy 3.4.0-RC2 Generated by Codox
Nippy 3.4.0-RC2
\ No newline at end of file diff --git a/taoensso.nippy.html b/taoensso.nippy.html index 2e8df09..b48d09f 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,6 +1,6 @@ -Nippy 3.4.0-RC2
Released under the Eclipse Public License - v 1.0
The fastest serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "3.4.0-RC2"]Namespaces
taoensso.nippy
High-performance serialization library for Clojure.Public variables and functions:
- *auto-freeze-compressor*
- *custom-readers*
- *freeze-fallback*
- *freeze-serializable-allowlist*
- *incl-metadata?*
- *thaw-serializable-allowlist*
- *thaw-xform*
- -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
- IFreezable
- IFreezableWithMeta
- inspect-ba
- lz4-compressor
- lz4hc-compressor
- lzma2-compressor
- public-types-spec
- read-quarantined-serializable-object-unsafe!
- snappy-compressor
- stress-data
- 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
- zstd-compressor
taoensso.nippy.tools
Utils for community tools that want to add user-configurable Nippy support. Used by Carmine, Faraday, etc.Public variables and functions:
taoensso.nippy documentation Generated by Codox
Nippy 3.4.0-RC1
taoensso.nippy
High-performance serialization library for Clojure. +taoensso.nippy documentation Generated by Codox
Nippy 3.4.0-RC2
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}*freeze-fallback*
dynamic
Controls Nippy's behaviour when trying to freeze an item for which Nippy @@ -284,7 +284,7 @@ given id of form: * Keyword - 2 byte overhead, keywords hashed to 16 bit id * ℕ∈[1, 128] - 0 byte overhead -NB: be careful about extending to interfaces, Ref. <http://goo.gl/6gGRlU>;. +NB: be careful about extending to interfaces, Ref. <http://goo.gl/6gGRlU>. (defrecord MyRec [data]) (extend-freeze MyRec :foo/my-type [x data-output] ; Keyword id @@ -390,7 +390,12 @@ returns the object WITHOUT regard for `*thaw-serializable-allowlist*`. **MAY BE UNSAFE!** Don't call this unless you absolutely trust the payload to not contain any malicious code. -See `*thaw-serializable-allowlist*` for more info.stress-data
(stress-data {:keys [comparable?], :as opts})Returns map of reference stress data for use by tests, benchmarks, etc. +See `*thaw-serializable-allowlist*` for more info.snappy-compressor
Default `Snappy` compressor: + - Compression ratio: `C` (0.58 on reference benchmark). + - Compression speed: `A+` (206 msecs on reference benchmark). + - Decompression speed: `B` (134 msecs on reference benchmark). +Good general-purpose compressor, favours speed. +See `taoensso.nippy-benchmarks` for detailed comparative benchmarks.stress-data
(stress-data {:keys [comparable?], :as opts})Returns map of reference stress data for use by tests, benchmarks, etc.thaw
(thaw ba)(thaw ba {:as opts, :keys [v1-compatibility? compressor encryptor password serializable-allowlist incl-metadata? thaw-xform], :or {compressor :auto, encryptor :auto}})Deserializes a frozen Nippy byte array to its original Clojure data type. To thaw custom types, extend the Clojure reader or see `extend-thaw`. diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html index 0080470..e705a67 100644 --- a/taoensso.nippy.tools.html +++ b/taoensso.nippy.tools.html @@ -1,6 +1,6 @@ -taoensso.nippy.tools documentation Generated by Codox
Nippy 3.4.0-RC1
taoensso.nippy.tools
Utils for community tools that want to add user-configurable Nippy support. +taoensso.nippy.tools documentation Generated by Codox
Nippy 3.4.0-RC2
taoensso.nippy.tools
Utils for community 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 uses as options the following, merged in order of ascending preference: