\ No newline at end of file
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index fe93680..4ec6fbb 100644
--- a/taoensso.nippy.benchmarks.html
+++ b/taoensso.nippy.benchmarks.html
@@ -1,3 +1,3 @@
-taoensso.nippy.benchmarks documentation
\ No newline at end of file
diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html
index 0409373..c3a069e 100644
--- a/taoensso.nippy.compression.html
+++ b/taoensso.nippy.compression.html
@@ -1,6 +1,6 @@
-taoensso.nippy.compression documentation
Default 128bit AES encryptor with many-round SHA-512 key-gen.
@@ -35,6 +35,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.
\ No newline at end of file
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index e2332d5..9b3b51c 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,13 +1,14 @@
-taoensso.nippy documentation
Default 128bit AES encryptor with many-round SHA-512 key-gen.
Password form [:salted "my-password"]
---------------------------------------
@@ -40,49 +41,52 @@ 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.
Experimental! Wraps value so that future writes of the same wrapped
-value will be efficiently encoded as references to this one.
+increased danger if a key is somehow compromised.
Experimental, subject to change.
+
+Wraps value so that future writes of the same wrapped value with same
+metadata will be efficiently encoded as references to this one.
(freeze [(cache "foo") (cache "foo") (cache "foo")])
- will incl. a single "foo", plus 2x single-byte references to "foo".
(extend-freeze type custom-type-id [x out] & body)
Extends Nippy to support freezing of a custom type (ideally concrete) with
given id of form:
* Keyword - 2 byte overhead, resistent to id collisions
* Integer ∈[1, 128] - no overhead, subject to id collisions
-(defrecord MyType [data])
-(extend-freeze MyType :foo/my-type [x data-output] ; Keyword id
+NB: be careful about extending to interfaces, Ref. http://goo.gl/6gGRlU.
+
+(defrecord MyRec [data])
+(extend-freeze MyRec :foo/my-type [x data-output] ; Keyword id
(.writeUTF [data-output] (:data x)))
;; or
-(extend-freeze MyType 1 [x data-output] ; Byte id
- (.writeUTF [data-output] (:data x)))
Extends Nippy to support thawing of a custom type with given id:
+(extend-freeze MyRec 1 [x data-output] ; Byte id
+ (.writeUTF [data-output] (:data x)))
Extends Nippy to support thawing of a custom type with given id:
(extend-thaw :foo/my-type [data-input] ; Keyword id
- (MyType. (.readUTF data-input)))
+ (MyRec. (.readUTF data-input)))
;; or
(extend-thaw 1 [data-input] ; Byte id
- (MyType. (.readUTF data-input)))
Like `freeze` but:
- Writes data without a Nippy header
- Drops all support for compression and encryption
- Must be thawed with `fast-thaw`
Equivalent to (but a little faster than):
- `(freeze x {:compressor nil :encryptor nil :no-header? true})
Like `thaw` but:
- Drops all support for compression and encryption
- Supports only data frozen with `fast-freeze`
Equivalent to (but a little faster than):
- `(thaw x {:compressor nil :encryptor nil :no-header? true})
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})
Alpha - subject to change.
Returns truthy iff Nippy *appears* to support freezing the given argument.
`:allow-clojure-reader?` and `:allow-java-serializable?` options may be
used to enable the relevant roundtrip fallback test(s). These tests are
only **moderately reliable** since they're cached by arg type and don't
test for pre/post serialization value equality (there's no good general
-way of doing so).
Default net.jpountz.lz4 compressor:
Ratio: low.
Write speed: very high.
Read speed: very high.
@@ -90,24 +94,23 @@ Write speed: very high.
A good general-purpose compressor, competitive with Snappy.
Thanks to Max Penet (@mpenet) for our first implementation,
-Ref. https://github.com/mpenet/nippy-lz4
Default org.tukaani.xz.LZMA2 compressor:
Ratio: high.
Write speed: _very_ slow (also currently single-threaded).
Read speed: slow.
A specialized compressor for large, low-write data in space-sensitive
-environments.
Deserializes a frozen Nippy byte array to its original Clojure data type.
To thaw custom types, extend the Clojure reader or see `extend-thaw`.
** By default, supports data frozen with Nippy v2+ ONLY **
@@ -117,6 +120,7 @@ legacy versions of Nippy.
Options include:
:v1-compatibility? - support data frozen by legacy versions of Nippy?
:compressor - :auto (checks header, default) an ICompressor, or nil
- :encryptor - :auto (checks header, default), an IEncryptor, or nil
Deserializes a frozen object from given DataInput to its original Clojure
-data type. Please note that this is a low-level util: in most cases you'll
-want `thaw` instead.
Deserializes a frozen object from given DataInput to its original Clojure
+data type.
+
+This is a low-level util: in most cases you'll want `thaw` instead.
\ No newline at end of file
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index d82b186..0a2000b 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,10 +1,9 @@
-taoensso.nippy.tools documentation
Ensures that given arg (any freezable data type) is wrapped so that
(tools/freeze <wrapped-arg>) will serialize as
-(nippy/freeze <unwrapped-arg> <opts>).
\ No newline at end of file
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 72e8f14..e9dae1f 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,6 +1,6 @@
-taoensso.nippy.utils documentation
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})
Alpha - subject to change.
Returns truthy iff Nippy *appears* to support freezing the given argument.
`:allow-clojure-reader?` and `:allow-java-serializable?` options may be