diff --git a/index.html b/index.html index 272c2f8..bb4d436 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Nippy 2.0.0 API documentation

Nippy 2.0.0 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.
+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
+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
 deserves some privacy.
      Public variables and functions:
      taoensso.nippy.tools
      Alpha - subject to change.
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index f5a1d89..75c51a1 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 1692ba7..8d8957d 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 daf4c75..16b411a 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 81383ac..cdec983 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,11 +1,22 @@
 
-taoensso.nippy documentation
      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.
+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])
+(extend-freeze MyType 1 [x data-output-stream]
+  (.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
+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.
 
      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}, :as opts}])
      Deserializes frozen bytes to their original Clojure data type. Supports data
-frozen with current and all previous versions of Nippy.
+
      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
+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.
-
      
\ No newline at end of file
+
      thaw-from-stream!
      (thaw-from-stream! data-input-stream & [{:keys [read-eval?]}])
      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 f21db2e..81432cf 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 5dae9f8..31dda0d 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.