diff --git a/index.html b/index.html index 9c86ae1..ad65edd 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,8 @@ -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
+Nippy 2.0.0-RC1 API documentation
Nippy 2.0.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
-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.tools
    Alpha - subject to change.
+Utilities for third-party tools that want to add fully-user-configurable Nippy
+support. Used by Carmine and Faraday.
    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 d782fb7..25d3aa8 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 74fbc07..481e372 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 44e0a49..e873eca 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 5aebbc3..b3258fe 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,9 +1,9 @@
 
-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.
    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
+
    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.
 
 WARNING: Enabling `:read-eval?` can lead to security vulnerabilities unless
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
new file mode 100644
index 0000000..3835383
--- /dev/null
+++ b/taoensso.nippy.tools.html
@@ -0,0 +1,13 @@
+
+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.
+
    freeze
    (freeze x & [{:keys [default-opts]}])
    Like `nippy/freeze` but takes options from special argument wrapper when
+present.
    map->EncryptedFrozen
    (map->EncryptedFrozen m__5665__auto__)
    Factory function for class taoensso.nippy.tools.EncryptedFrozen, taking a map of keywords to field values.
+
    map->WrappedForFreezing
    (map->WrappedForFreezing m__5665__auto__)
    Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
+
    thaw
    (thaw ba & {:keys [default-opts]})
    Like `nippy/thaw` but takes options from *thaw-opts* binding, and wraps
+encrypted bytes for easy identification when no password has been provided
+for decryption.
    with-thaw-opts
    macro
    (with-thaw-opts opts & body)
    Evaluates body using given options for any automatic deserialization in
+context.
    wrap-for-freezing
    (wrap-for-freezing value & [opts])
    Wraps arg (any freezable data type) so that (tools/freeze <wrapped-arg>)
+will serialize the arg using given options.
    
\ No newline at end of file
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index f15c9d4..521ccfd 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.