taoensso.nippy documentation

Simple, high-performance Clojure serialization library. Originally adapted
from Deep-Freeze.

freeze

(freeze x & [{:keys [print-dup? password compressor encryptor legacy-mode], :or {print-dup? true, compressor snappy-compressor, encryptor aes128-encryptor}}])
Serializes arg (any Clojure data type) to a byte array. Set :legacy-mode to
true to produce bytes readble by Nippy < 2.x.

freeze-to-bytes

(freeze-to-bytes x & {:keys [print-dup? compress?], :or {print-dup? true, compress? true}})
DEPRECATED: Use `freeze` instead.

stress-data

Reference data used for tests & benchmarks.

thaw

(thaw ba & [{:keys [read-eval? password compressor encryptor legacy-opts], :or {legacy-opts {:compressed? true}, compressor snappy-compressor, encryptor aes128-encryptor}}])
Deserializes frozen bytes to their original Clojure data type. Supports data
frozen with current and all previous versions of Nippy.

WARNING: Enabling `:read-eval?` can lead to security vulnerabilities unless
you are sure you know what you're doing.

thaw-from-bytes

(thaw-from-bytes ba & {:keys [read-eval? compressed?], :or {compressed? true}})
DEPRECATED: Use `thaw` instead.