From 301739661251d6a34ca0e24df56da60bcce1dc29 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Fri, 25 Oct 2013 13:44:53 +0700 Subject: [PATCH] v2.5.0-beta1 --- index.html | 10 ++++++---- taoensso.nippy.benchmarks.html | 2 +- taoensso.nippy.compression.html | 19 +++++++++++++++---- taoensso.nippy.encryption.html | 2 +- taoensso.nippy.html | 12 ++++++++---- taoensso.nippy.tools.html | 2 +- taoensso.nippy.utils.html | 2 +- 7 files changed, 33 insertions(+), 16 deletions(-) diff --git a/index.html b/index.html index ca67da5..a155ed2 100644 --- a/index.html +++ b/index.html @@ -1,8 +1,10 @@ -Nippy 2.2.0 API documentation

Nippy 2.2.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.
+Nippy 2.5.0-beta1 API documentation
Nippy 2.5.0-beta1 API documentation
Clojure serialization library
taoensso.nippy
Simple, high-performance Clojure serialization library. Originally adapted
+from Deep-Freeze.
Public variables and functions:
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.
 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
+support. Used by Carmine and Faraday.
Public variables and functions:
taoensso.nippy.utils
Public variables and functions:
taoensso.nippy
Simple, high-performance Clojure serialization library. Originally adapted
+from Deep-Freeze.
Public variables and functions:

\ No newline at end of file
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index 49a93e0..160907d 100644
--- a/taoensso.nippy.benchmarks.html
+++ b/taoensso.nippy.benchmarks.html
@@ -1,2 +1,2 @@
 
-taoensso.nippy.benchmarks documentation
taoensso.nippy.benchmarks documentation
bench
(bench {:keys [reader? laps], :or {reader? true, laps 1}})
bench*
macro
(bench* & body)
data
freeze-reader
(freeze-reader x)
roundtrip-defaults
roundtrip-encrypted
roundtrip-fast
roundtrip-reader
thaw-reader
(thaw-reader x)

\ No newline at end of file
+taoensso.nippy.benchmarks documentation
taoensso.nippy.benchmarks documentation
bench
(bench {:keys [reader? lzma2? laps], :or {laps 1}})
bench*
macro
(bench* & body)
bench1
(bench1 freezer thawer & [sizer])
data

\ No newline at end of file
diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html
index 9de4f6b..2434c81 100644
--- a/taoensso.nippy.compression.html
+++ b/taoensso.nippy.compression.html
@@ -1,5 +1,16 @@
 
-taoensso.nippy.compression documentation
taoensso.nippy.compression documentation
Alpha - subject to change.
-
->SnappyCompressor
(->SnappyCompressor)
Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
-
ICompressor
compress
(compress compressor ba)
decompress
(decompress compressor ba)
snappy-compressor
Default org.iq80.snappy.Snappy compressor.
-

\ No newline at end of file
+taoensso.nippy.compression documentation
taoensso.nippy.compression documentation
Alpha - subject to change.
+
->LZMA2Compressor
(->LZMA2Compressor compression-level)
Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
+
->SnappyCompressor
(->SnappyCompressor)
Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
+
ICompressor
compress
(compress compressor ba)
decompress
(decompress compressor ba)
lzma2-compressor
Alpha - subject to change.
+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.
snappy-compressor
Default org.iq80.snappy.Snappy compressor:
+      Ratio: low.
+Write speed: very high.
+ Read speed: very high.
+
+A good general-purpose compressor for Redis.

\ No newline at end of file
diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html
index d25fdb3..818a206 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.
 
IEncryptor
aes128-encryptor
Alpha - subject to change.
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index aa8c44f..2c6ab6a 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,7 +1,10 @@
 
-taoensso.nippy documentation
taoensso.nippy documentation
Simple, high-performance Clojure serialization library. Originally adapted
-from Deep-Freeze.
Freezable
custom-readers
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]:
+taoensso.nippy documentation
taoensso.nippy documentation
Simple, high-performance Clojure serialization library. Originally adapted
+from Deep-Freeze.
->StressRecord
(->StressRecord data)
Positional factory function for class taoensso.nippy.StressRecord.
+
Freezable
Be careful about extending to interfaces, Ref. http://goo.gl/6gGRlU.
+
custom-readers
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 (ideally concrete) 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.
@@ -11,7 +14,8 @@ Extends Nippy to support thawing of a custom type with id ∈[1, 128]:
 true to produce bytes readable by Nippy < 2.x. For custom types extend the
 Clojure reader or see `extend-freeze`.
freeze-to-bytes
(freeze-to-bytes x & {:keys [compress?], :or {compress? true}})
DEPRECATED: Use `freeze` instead.
 
freeze-to-stream!
(freeze-to-stream! data-output-stream x & _)
Low-level API. Serializes arg (any Clojure data type) to a DataOutputStream.
-
freeze-to-stream*
(freeze-to-stream* this stream)
id-bigdec
id-bigint
id-boolean
id-byte
id-bytes
id-char
id-date
id-double
id-float
id-integer
id-keyword
id-list
id-long
id-map
id-meta
id-nil
id-old-keyword
id-old-map
id-old-reader
id-old-string
id-queue
id-ratio
id-reader
id-record
id-reserved
id-seq
id-set
id-short
id-sorted-map
id-sorted-set
id-string
id-uuid
id-vector
stress-data
Reference data used for tests & benchmarks.
+
freeze-to-stream*
(freeze-to-stream* this stream)
id-bigdec
id-bigint
id-boolean
id-byte
id-bytes
id-char
id-date
id-double
id-float
id-integer
id-keyword
id-list
id-long
id-map
id-meta
id-nil
id-old-keyword
id-old-map
id-old-reader
id-old-string
id-queue
id-ratio
id-reader
id-record
id-reserved
id-seq
id-serializable
id-set
id-short
id-sorted-map
id-sorted-set
id-string
id-uuid
id-vector
map->StressRecord
(map->StressRecord m__5665__auto__)
Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
+
stress-data
Reference data used for tests & benchmarks.
 
thaw
(thaw ba & [{:keys [password compressor encryptor legacy-opts], :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`.
thaw-from-bytes
(thaw-from-bytes ba & {:keys [compressed?], :or {compressed? true}})
DEPRECATED: Use `thaw` instead.
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 7fcd951..42065df 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.
*thaw-opts*
->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 7c92b6c..308913f 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.utils documentation
taoensso.nippy.utils documentation
ba-concat
(ba-concat ba1 ba2)
ba-split
(ba-split ba idx)
ba=
(ba= x y)
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
ba-concat
(ba-concat ba1 ba2)
ba-split
(ba-split ba idx)
ba=
(ba= x y)
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.