diff --git a/index.html b/index.html index 27912b1..9c86ae1 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Nippy 2.0.0-alpha5 API documentation

Nippy 2.0.0-alpha5 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.
+Nippy 2.0.0-alpha7 API documentation
    Nippy 2.0.0-alpha7 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.utils
      Public variables and functions:
      
\ No newline at end of file
+deserves some privacy.
      Public variables and functions:
      taoensso.nippy.utils
      Public variables and functions:
      
\ No newline at end of file
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index 944656b..d782fb7 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 1da146a..74fbc07 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.
-
      ->DefaultSnappyCompressor
      (->DefaultSnappyCompressor)
      Positional factory function for class taoensso.nippy.compression.DefaultSnappyCompressor.
-
      default-snappy-compressor
      Default org.iq80.snappy.Snappy compressor.
+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 eb18fed..44e0a49 100644
--- a/taoensso.nippy.encryption.html
+++ b/taoensso.nippy.encryption.html
@@ -1,8 +1,8 @@
 
-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.
      ->DefaultAES128Encryptor
      (->DefaultAES128Encryptor key-cache)
      Positional factory function for class taoensso.nippy.encryption.DefaultAES128Encryptor.
-
      default-aes128-encryptor
      Alpha - subject to change.
+deserves some privacy.
      ->AES128Encryptor
      (->AES128Encryptor key-cache)
      Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
+
      aes128-encryptor
      Alpha - subject to change.
 Default 128bit AES encryptor with multi-round SHA-512 keygen.
 
 Password form [:salted "my-password"]
@@ -36,5 +36,5 @@ CONS: Using a small number of keys for many encrypted items means that if any
       compromised.
 
 Faster than `aes128-salted`, and harder to attack any particular key - but
-increased danger if a key is somehow compromised.
      map->DefaultAES128Encryptor
      (map->DefaultAES128Encryptor m__5665__auto__)
      Factory function for class taoensso.nippy.encryption.DefaultAES128Encryptor, taking a map of keywords to field values.
+increased danger if a key is somehow compromised.
      map->AES128Encryptor
      (map->AES128Encryptor m__5665__auto__)
      Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
 
      
\ No newline at end of file
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index 492ab03..5aebbc3 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,20 +1,11 @@
 
-taoensso.nippy documentation
      taoensso.nippy documentation
      Simple, high-performance Clojure serialization library. Originally adapted
-from Deep-Freeze.
      coll-thaw
      (coll-thaw coll s)
      Thaws simple collection types.
-
      coll-thaw-kvs
      (coll-thaw-kvs coll s)
      Thaws key-value collection types.
-
      freeze
      (freeze x & [{:keys [print-dup? password compressor encryptor legacy-mode], :or {print-dup? true, compressor compression/default-snappy-compressor, encryptor encryption/default-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? password], :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.
      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-mode strict?], :or {legacy-mode :auto, compressor compression/default-snappy-compressor, encryptor encryption/default-aes128-encryptor}}])
      Deserializes frozen bytes to their original Clojure data type.
-
-:legacy-mode options:
-  false - Nippy >= 2.x data only (best).
-  true  - Nippy  < 2.x data only (deprecated).
-  :auto - Mixed data (default, migrating).
-
-In most cases you'll want :auto if you're using a preexisting data set, and
-`false` otherwise.
+
      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? password], :or {compressed? true}})
      DEPRECATED: Use `thaw` instead.
+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
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index c2bb002..f15c9d4 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,8 +1,8 @@
 
-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
      (repeatedly-into coll n f)
      Like `repeatedly` but faster and `conj`s items into given collection.
+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.
 
      time-ns
      macro
      (time-ns & body)
      Returns number of nanoseconds it takes to execute body.
 
      version-compare
      (version-compare x y)
      Comparator for version strings like x.y.z, etc.
 
      
\ No newline at end of file