From 8a57a1b7340aaff2004a6a754e883865a8438475 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Mon, 28 Oct 2024 11:46:09 +0100 Subject: [PATCH] v3.5.0-RC1 (2024-10-28) --- index.html | 2 +- taoensso.nippy.html | 50 ++++++++++++++++++++++----------------- taoensso.nippy.tools.html | 2 +- 3 files changed, 30 insertions(+), 24 deletions(-) diff --git a/index.html b/index.html index 6d90ca0..1c83bf3 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Nippy 3.4.2

Project

Namespaces

Nippy 3.4.2

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.2"]

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.5.0-RC1
Project
Namespaces
Nippy 3.5.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.5.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.
 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 c35cb79..a0458d4 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
@@ -268,9 +268,7 @@ then merge the recorded classes into Nippy's default allowlist/s, e.g.:
 
 (alter-var-root #'thaw-serializable-allowlist*
   (fn [_] (into default-thaw-serializable-allowlist
-            (keys (get-recorded-serializable-classes)))))
cache
(cache x)
Experimental, subject to change. Feedback welcome!
-
-Wraps value so that future writes of the same wrapped value with same
+            (keys (get-recorded-serializable-classes)))))
cache
(cache x)
Wraps value so that future writes of the same wrapped value with same
 metadata will be efficiently encoded as references to this one.
 
 (freeze [(cache "foo") (cache "foo") (cache "foo")])
@@ -302,17 +300,20 @@ NB: be careful about extending to interfaces, Ref. <
fast-thaw
(fast-thaw ba)
Like `thaw` but:
-  - Drops all support for compression and encryption
+Equivalent to (but a little faster than) `freeze` with opts
+  {:no-header? true, :compressor nil, :encryptor nil}.
+
+Intended for use only by advanced users that clearly understand the tradeoffs.
+I STRONGLY recommend that most users prefer the standard `freeze` since:
+  - The Nippy header is useful for data portability and preservation
+  - Compression is often benefitial at little/no cost
+  - The performance difference between `freeze` and `fast-freeze` is
+    often negligible in practice.