From 5469cac423960dec212ce0efe4d5f794ba35fee5 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Wed, 6 Nov 2013 20:56:35 +0700 Subject: [PATCH] v2.5.0-RC1 --- index.html | 8 +++----- taoensso.nippy.benchmarks.html | 2 +- taoensso.nippy.compression.html | 2 +- taoensso.nippy.encryption.html | 2 +- taoensso.nippy.html | 8 +++++--- taoensso.nippy.tools.html | 4 ++-- taoensso.nippy.utils.html | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/index.html b/index.html index a155ed2..93901c6 100644 --- a/index.html +++ b/index.html @@ -1,10 +1,8 @@ -Nippy 2.5.0-beta1 API documentation

Nippy 2.5.0-beta1 API documentation

Clojure serialization library

taoensso.nippy.benchmarks

Public variables and functions:

taoensso.nippy.compression

Alpha - subject to change.
+Nippy 2.5.0-RC1 API documentation

Nippy 2.5.0-RC1 API documentation

Clojure serialization library

taoensso.nippy.benchmarks

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.

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.
\ No newline at end of file +support. Used by Carmine and Faraday.
\ No newline at end of file diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index 160907d..2c226fc 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? lzma2? laps], :or {laps 1}})

bench*

macro

(bench* & body)

bench1

(bench1 freezer thawer & [sizer])

data

\ 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 2434c81..84abeea 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.
 

->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.
diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html
index 818a206..5bfe155 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 2c6ab6a..b57a92b 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,6 +1,7 @@
 
-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.
+taoensso.nippy documentation

taoensso.nippy documentation

Simple, high-performance Clojure serialization library. Originally adapted
+from Deep-Freeze.

->Compressable-LZMA2

(->Compressable-LZMA2 value)
Positional factory function for class taoensso.nippy.Compressable-LZMA2.
+

->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
@@ -14,7 +15,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-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.
+

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->Compressable-LZMA2

(map->Compressable-LZMA2 m__5665__auto__)
Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
+

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
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 42065df..5b48580 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,12 +1,12 @@
 
-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.
 

encrypted-frozen?

(encrypted-frozen? x)

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
+

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>)
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 308913f..dda321f 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.