From 1ec2d7d70c54fd9688fa8365803ec4ea5f3949a3 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Fri, 14 Jun 2013 19:02:10 +0700 Subject: [PATCH] Update (2.0.0-alpha5) --- index.html | 2 +- taoensso.nippy.benchmarks.html | 2 +- taoensso.nippy.compression.html | 2 +- taoensso.nippy.encryption.html | 2 +- taoensso.nippy.html | 17 ++++++++++++----- taoensso.nippy.utils.html | 2 +- 6 files changed, 17 insertions(+), 10 deletions(-) diff --git a/index.html b/index.html index 31dd995..27912b1 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -Nippy 2.0.0-alpha1 API documentation

Nippy 2.0.0-alpha1 API documentation

Clojure serialization library

taoensso.nippy

Simple, high-performance Clojure serialization library. Originally adapted
+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.
 Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index 103bf95..944656b 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 3a1dc97..1da146a 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.
 
    ->DefaultSnappyCompressor
    (->DefaultSnappyCompressor)
    Positional factory function for class taoensso.nippy.compression.DefaultSnappyCompressor.
 
    default-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 7872895..eb18fed 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.
    ->DefaultAES128Encryptor
    (->DefaultAES128Encryptor key-cache)
    Positional factory function for class taoensso.nippy.encryption.DefaultAES128Encryptor.
 
    default-aes128-encryptor
    Alpha - subject to change.
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index c6f252b..492ab03 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,12 +1,19 @@
 
-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.
    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. Enable
-`:legacy-mode?` flag to produce bytes readable 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.
+
    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.
 
    stress-data
    Reference data used for tests & benchmarks.
-
    thaw
    (thaw ba & [{:keys [read-eval? password compressor encryptor legacy-mode? strict?], :or {compressor compression/default-snappy-compressor, encryptor encryption/default-aes128-encryptor}}])
    Deserializes frozen bytes to their original Clojure data type. Enable
-`:legacy-mode?` to read bytes written by Nippy < 2.x.
+
    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.
 
 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.
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 39650df..c2bb002 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
    (repeatedly-into coll n f)
    Like `repeatedly` but faster and `conj`s items into given collection.