From b4c58ae5cb1b280a854a925ee7805f077b9f4b87 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Wed, 12 Mar 2014 12:15:19 +0700 Subject: [PATCH] v2.6.0-RC1 --- index.html | 6 +++--- taoensso.nippy.benchmarks.html | 2 +- taoensso.nippy.compression.html | 2 +- taoensso.nippy.encryption.html | 4 ++-- taoensso.nippy.html | 21 +++++++++++++++------ taoensso.nippy.tools.html | 6 +++--- taoensso.nippy.utils.html | 14 ++++++++------ 7 files changed, 33 insertions(+), 22 deletions(-) diff --git a/index.html b/index.html index 9b4a043..825b2c1 100644 --- a/index.html +++ b/index.html @@ -1,8 +1,8 @@ -Nippy 2.6.0-alpha1 API documentation

Nippy 2.6.0-alpha1 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.
+Nippy 2.6.0-RC1 API documentation
Nippy 2.6.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.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:

\ No newline at end of file
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index a1f8f73..2fcfea4 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? fressian? laps], :or {laps 1}})
bench*
macro
(bench* & body)
bench1
(bench1 freezer thawer & [sizer])
data
fressian-freeze
(fressian-freeze value)
fressian-thaw
(fressian-thaw value)

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

\ No newline at end of file
diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html
index e3aa6f8..393945d 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 c1acedc..da37ba3 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.
@@ -36,5 +36,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.
decrypt
(decrypt encryptor pwd ba)
encrypt
(encrypt encryptor pwd ba)
map->AES128Encryptor
(map->AES128Encryptor m__5665__auto__)
Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
+increased danger if a key is somehow compromised.
decrypt
(decrypt encryptor pwd ba)
encrypt
(encrypt encryptor pwd ba)
map->AES128Encryptor
(map->AES128Encryptor m__5869__auto__)
Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
 

\ No newline at end of file
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index 86d322b..3ffce1b 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,5 +1,5 @@
 
-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.
*final-freeze-fallback*
Alpha - subject to change.
 
->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.
@@ -17,10 +17,18 @@ 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-out!
(freeze-to-out! data-output x & _)
Low-level API. Serializes arg (any Clojure data type) to a DataOutput.
 
freeze-to-out*
(freeze-to-out* this out)
freeze-to-stream!
DEPRECATED: Use `freeze-to-out!` instead.
-
id-bigdec
id-bigint
id-boolean
id-byte
id-byte-as-long
id-bytes
id-char
id-date
id-double
id-float
id-int-as-long
id-integer
id-keyword
id-keyword-small
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-short-as-long
id-sorted-map
id-sorted-set
id-string
id-string-small
id-uuid
id-vector
inspect-ba
(inspect-ba ba & [thaw-opts])
Alpha - subject to change.
-
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.
+
freezeable?
(freezeable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])
Alpha - subject to change, may be buggy!
+Returns truthy value iff Nippy supports de/serialization of given argument.
+Conservative with default options.
+
+`:allow-clojure-reader?` and `:allow-java-serializable?` options may be used
+to also 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 equality (there's no good general way of doing so).
id-bigdec
id-bigint
id-biginteger
id-boolean
id-byte
id-byte-as-long
id-bytes
id-char
id-date
id-double
id-float
id-int-as-long
id-integer
id-keyword
id-keyword-small
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-short-as-long
id-sorted-map
id-sorted-set
id-string
id-string-small
id-uuid
id-vector
inspect-ba
(inspect-ba ba & [thaw-opts])
Alpha - subject to change.
+
map->Compressable-LZMA2
(map->Compressable-LZMA2 m__5869__auto__)
Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
+
map->StressRecord
(map->StressRecord m__5869__auto__)
Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
+
read-biginteger
macro
(read-biginteger in)
read-bytes
macro
(read-bytes in & [small?])
read-compact-long
macro
(read-compact-long in)
EXPERIMENTAL!
+
read-utf8
macro
(read-utf8 in & [small?])
stress-data
Reference data used for tests & benchmarks.
 
stress-data-benchable
Reference data with stuff removed that breaks reader or other utils we'll
 be benching against.
stress-data-comparable
Reference data with stuff removed that breaks roundtrip equality.
 
thaw
(thaw ba & [{:keys [password compressor encryptor headerless-meta], :or {compressor snappy-compressor, encryptor aes128-encryptor, headerless-meta {:version 1, :compressed? true, :encrypted? false}}, :as opts}])
Deserializes a frozen object from given byte array to its original Clojure
@@ -35,4 +43,5 @@ fallback (`{:headerless-meta nil}`) if you're certain you won't be thawing
 headerless data.
thaw-from-bytes
(thaw-from-bytes ba & {:keys [compressed?], :or {compressed? true}})
DEPRECATED: Use `thaw` instead.
 
thaw-from-in!
(thaw-from-in! data-input & _)
Low-level API. Deserializes a frozen object from given DataInput to its
 original Clojure data type.
thaw-from-stream!
DEPRECATED: Use `thaw-from-in!` instead.
-
when-debug-mode
macro
(when-debug-mode & body)
write-id
macro
(write-id out id)

\ No newline at end of file
+
when-debug-mode
macro
(when-debug-mode & body)
write-biginteger
macro
(write-biginteger out x)
write-bytes
macro
(write-bytes out ba & [small?])
write-compact-long
macro
(write-compact-long out x)
EXPERIMENTAL! Uses 2->9 bytes.
+
write-id
macro
(write-id out id)
write-utf8
macro
(write-utf8 out x & [small?])

\ No newline at end of file
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 92e5305..cdccd78 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,11 +1,11 @@
 
-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.
+present.
map->EncryptedFrozen
(map->EncryptedFrozen m__5869__auto__)
Factory function for class taoensso.nippy.tools.EncryptedFrozen, taking a map of keywords to field values.
+
map->WrappedForFreezing
(map->WrappedForFreezing m__5869__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
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 67b6310..a6511a4 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,7 +1,9 @@
 
-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 nlaps {:keys [nlaps-warmup nthreads as-ns?], :or {nlaps-warmup 0, nthreads 1}} & body)
Repeatedly executes body and returns time taken to complete execution.
-
bytes-class
bytes?
(bytes? x)
case-eval
macro
(case-eval e & clauses)
Like `case` but evaluates test constants for their compile-time value.
-
memoized
(memoized cache f & args)
Like `(partial memoize* {})` but takes an explicit cache atom (possibly nil)
-and immediately applies memoized f to given arguments.
readable?
repeatedly-into
macro
(repeatedly-into coll n & body)
Like `repeatedly` but faster and `conj`s items into given collection.
-
serializable?
time-ns
macro
(time-ns & body)
Returns number of nanoseconds it takes to execute body.
-

\ No newline at end of file
+taoensso.nippy.utils documentation
taoensso.nippy.utils documentation
freezable?
(freezable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])
Alpha - subject to change, may be buggy!
+Returns truthy value iff Nippy supports de/serialization of given argument.
+Conservative with default options.
+
+`:allow-clojure-reader?` and `:allow-java-serializable?` options may be used
+to also 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 equality (there's no good general way of doing so).
readable?
serializable?

\ No newline at end of file