diff --git a/index.html b/index.html index bb4d436..4f0d37a 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -Nippy 2.1.0 API documentation

Nippy 2.1.0 API documentation

Clojure serialization library

taoensso.nippy

Simple, high-performance Clojure serialization library. Originally adapted
+Nippy 2.2.0-RC1 API documentation
Nippy 2.2.0-RC1 API documentation
Clojure serialization library
taoensso.nippy
Simple, high-performance Clojure serialization library. Originally adapted
 from Deep-Freeze.
Public variables and functions:
taoensso.nippy.benchmarks
Public variables and functions:
    taoensso.nippy.compression
    Alpha - subject to change.
 
    Public variables and functions:
    taoensso.nippy.encryption
    Alpha - subject to change.
 Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index 75c51a1..6b1ffd0 100644
--- a/taoensso.nippy.benchmarks.html
+++ b/taoensso.nippy.benchmarks.html
@@ -1,2 +1,2 @@
 
-taoensso.nippy.benchmarks documentation
    taoensso.nippy.benchmarks documentation
    
\ No newline at end of file
+taoensso.nippy.benchmarks documentation
    taoensso.nippy.benchmarks documentation
    
\ No newline at end of file
diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html
index 8d8957d..10910f0 100644
--- a/taoensso.nippy.compression.html
+++ b/taoensso.nippy.compression.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.compression documentation
    taoensso.nippy.compression documentation
    Alpha - subject to change.
+taoensso.nippy.compression documentation
    taoensso.nippy.compression documentation
    Alpha - subject to change.
 
    ->SnappyCompressor
    (->SnappyCompressor)
    Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
 
    snappy-compressor
    Default org.iq80.snappy.Snappy compressor.
 
    
\ No newline at end of file
diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html
index 16b411a..7f9b3b7 100644
--- a/taoensso.nippy.encryption.html
+++ b/taoensso.nippy.encryption.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.encryption documentation
    taoensso.nippy.encryption documentation
    Alpha - subject to change.
+taoensso.nippy.encryption documentation
    taoensso.nippy.encryption documentation
    Alpha - subject to change.
 Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
 deserves some privacy.
    ->AES128Encryptor
    (->AES128Encryptor key-cache)
    Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
 
    aes128-encryptor
    Alpha - subject to change.
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index cdec983..f9e1470 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy documentation
    taoensso.nippy documentation
    Simple, high-performance Clojure serialization library. Originally adapted
+taoensso.nippy documentation
    taoensso.nippy documentation
    Simple, high-performance Clojure serialization library. Originally adapted
 from Deep-Freeze.
    extend-freeze
    macro
    (extend-freeze type custom-type-id [x stream] & body)
    Alpha - subject to change.
 Extends Nippy to support freezing of a custom type with id ∈[1, 128]:
 (defrecord MyType [data])
@@ -7,16 +7,13 @@ Extends Nippy to support freezing of a custom type with id ∈[1, 128]:
   (.writeUTF [data-output-stream] (:data x)))
    extend-thaw
    macro
    (extend-thaw custom-type-id [stream] & body)
    Alpha - subject to change.
 Extends Nippy to support thawing of a custom type with id ∈[1, 128]:
 (extend-thaw 1 [data-input-stream]
-  (->MyType (.readUTF data-input-stream)))
    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
+  (->MyType (.readUTF data-input-stream)))
    freeze
    (freeze x & [{:keys [password compressor encryptor legacy-mode], :or {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. For custom types extend the
-Clojure reader or see `extend-freeze`.
    freeze-to-bytes
    (freeze-to-bytes x & {:keys [print-dup? compress?], :or {print-dup? true, compress? true}})
    DEPRECATED: Use `freeze` instead.
-
    freeze-to-stream!
    (freeze-to-stream! data-output-stream x & [{:keys [print-dup?], :or {print-dup? true}}])
    Low-level API. Serializes arg (any Clojure data type) to a DataOutputStream.
+Clojure reader or see `extend-freeze`.
    freeze-to-bytes
    (freeze-to-bytes x & {:keys [compress?], :or {compress? true}})
    DEPRECATED: Use `freeze` instead.
+
    freeze-to-stream!
    (freeze-to-stream! data-output-stream x & _)
    Low-level API. Serializes arg (any Clojure data type) to a DataOutputStream.
 
    stress-data
    Reference data used for tests & benchmarks.
-
    thaw
    (thaw ba & [{:keys [read-eval? password compressor encryptor legacy-opts readers], :or {legacy-opts {:compressed? true}, compressor snappy-compressor, encryptor aes128-encryptor}, :as opts}])
    Deserializes a frozen object from given byte array to its original Clojure
+
    thaw
    (thaw ba & [{:keys [password compressor encryptor legacy-opts], :or {legacy-opts {:compressed? true}, compressor snappy-compressor, encryptor aes128-encryptor}, :as opts}])
    Deserializes a frozen object from given byte array to its original Clojure
 data type. Supports data frozen with current and all previous versions of
-Nippy. For custom types extend the Clojure reader or see `extend-thaw`.
-
-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.
-
    thaw-from-stream!
    (thaw-from-stream! data-input-stream & [{:keys [read-eval?]}])
    Low-level API. Deserializes a frozen object from given DataInputStream to its
+Nippy. For custom types extend the Clojure reader or see `extend-thaw`.
    thaw-from-bytes
    (thaw-from-bytes ba & {:keys [compressed?], :or {compressed? true}})
    DEPRECATED: Use `thaw` instead.
+
    thaw-from-stream!
    (thaw-from-stream! data-input-stream)
    Low-level API. Deserializes a frozen object from given DataInputStream to its
 original Clojure data type.
    
\ No newline at end of file
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 81432cf..f967960 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.tools documentation
    taoensso.nippy.tools documentation
    Alpha - subject to change.
+taoensso.nippy.tools documentation
    taoensso.nippy.tools documentation
    Alpha - subject to change.
 Utilities for third-party tools that want to add fully-user-configurable Nippy
 support. Used by Carmine and Faraday.
    ->EncryptedFrozen
    (->EncryptedFrozen ba)
    Positional factory function for class taoensso.nippy.tools.EncryptedFrozen.
 
    ->WrappedForFreezing
    (->WrappedForFreezing value opts)
    Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 31dda0d..c051bc3 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.utils documentation
    taoensso.nippy.utils documentation
    bench
    macro
    (bench num-laps form & {:keys [warmup-laps num-threads as-ns?]})
    Repeatedly executes form and returns time taken to complete execution.
+taoensso.nippy.utils documentation
    taoensso.nippy.utils documentation
    bench
    macro
    (bench num-laps form & {:keys [warmup-laps num-threads as-ns?]})
    Repeatedly executes form and returns time taken to complete execution.
 
    case-eval
    macro
    (case-eval e & clauses)
    Like `case` but evaluates test constants for their compile-time value.
 
    memoized
    (memoized cache f & args)
    Like `memoize` but takes an explicit cache atom (possibly nil) and
 immediately applies memoized f to given arguments.
    repeatedly-into
    macro
    (repeatedly-into coll n & body)
    Like `repeatedly` but faster and `conj`s items into given collection.