From b42288890c29c8cccb5f47c3d529f2e1335b0eae Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Mon, 26 Feb 2024 10:52:06 +0100 Subject: [PATCH] v3.4.0-RC2 (2024-02-26) --- index.html | 2 +- taoensso.nippy.html | 11 ++++++++--- taoensso.nippy.tools.html | 2 +- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/index.html b/index.html index d88b52ed..c4cdfe85 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Nippy 3.4.0-RC1

Project

Namespaces

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:

taoensso.nippy.tools

Utils for community tools that want to add user-configurable Nippy support.
+Nippy 3.4.0-RC2
Project
Namespaces
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:
taoensso.nippy.tools
Utils for community tools that want to add user-configurable Nippy support.
 Used by Carmine, Faraday, etc.
Public variables and functions:

\ No newline at end of file
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index 2e8df093..b48d09fa 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,6 +1,6 @@
 
-taoensso.nippy documentation
Project
Namespaces
Public Vars
taoensso.nippy
High-performance serialization library for Clojure.
+taoensso.nippy documentation
Project
Namespaces
Public Vars
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 @@
   * 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 @@
 **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 00804706..e705a67d 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,6 +1,6 @@
 
-taoensso.nippy.tools documentation
Project
Namespaces
Public Vars
taoensso.nippy.tools
Utils for community tools that want to add user-configurable Nippy support.
+taoensso.nippy.tools documentation
Project
Namespaces
Public Vars
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: