diff --git a/index.html b/index.html index b4e6288..9993dac 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -Nippy 2.7.0-alpha1 API documentation

Nippy 2.7.0-alpha1

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
Public variables and functions:
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
+Nippy 2.9.0-beta2 API documentation
Nippy 2.9.0-beta2
Clojure serialization library
taoensso.nippy
High-performance JVM Clojure serialization library. Originally adapted from
+Deep-Freeze.
Public variables and functions:
taoensso.nippy.benchmarks
Public variables and functions:
taoensso.nippy.compression
Public variables and functions:
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
 deserves some privacy.
Public variables and functions:
taoensso.nippy.tools
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
diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html
index 340d777..29e56a2 100644
--- a/taoensso.nippy.benchmarks.html
+++ b/taoensso.nippy.benchmarks.html
@@ -1,2 +1,2 @@
 
-taoensso.nippy.benchmarks documentation
taoensso.nippy.benchmarks
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
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 604c824..d1b1496 100644
--- a/taoensso.nippy.compression.html
+++ b/taoensso.nippy.compression.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.compression documentation
taoensso.nippy.compression
->LZ4Compressor
(->LZ4Compressor compressor decompressor)
Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
+taoensso.nippy.compression documentation
taoensso.nippy.compression
->LZ4Compressor
(->LZ4Compressor compressor decompressor)
Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
 
->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
protocol
members
compress
(compress compressor ba)
decompress
(decompress compressor ba)
header-id
(header-id compressor)
lz4-compressor
Default net.jpountz.lz4 compressor:
diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html
index 7d60aca..5d492ce 100644
--- a/taoensso.nippy.encryption.html
+++ b/taoensso.nippy.encryption.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.encryption documentation
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
+taoensso.nippy.encryption documentation
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
 deserves some privacy.
->AES128Encryptor
(->AES128Encryptor key-gen key-cache)
Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
 
aes128-encryptor
Default 128bit AES encryptor with multi-round SHA-512 key-gen.
 
@@ -34,6 +34,6 @@ 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.
IEncryptor
protocol
members
decrypt
(decrypt encryptor pwd ba)
encrypt
(encrypt encryptor pwd ba)
header-id
(header-id encryptor)
map->AES128Encryptor
(map->AES128Encryptor m__5869__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.
IEncryptor
protocol
members
decrypt
(decrypt encryptor pwd ba)
encrypt
(encrypt encryptor pwd ba)
header-id
(header-id encryptor)
map->AES128Encryptor
(map->AES128Encryptor m__6249__auto__)
Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
 
standard-header-ids
These'll support :auto thaw.
 

\ No newline at end of file
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index 77eb995..60c4200 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,6 +1,6 @@
 
-taoensso.nippy documentation
taoensso.nippy
Simple, high-performance Clojure serialization library. Originally adapted
-from Deep-Freeze.
*final-freeze-fallback*
dynamic
Alpha - subject to change.
+taoensso.nippy documentation
taoensso.nippy
High-performance JVM Clojure serialization library. Originally adapted from
+Deep-Freeze.
*final-freeze-fallback*
dynamic
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.
 
aes128-encryptor
Default 128bit AES encryptor with multi-round SHA-512 key-gen.
@@ -36,8 +36,12 @@ 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.
coerce-custom-type-id
(coerce-custom-type-id custom-type-id)
* +ive byte id -> -ive byte id (for unprefixed custom types).
-* Keyword id   -> Short hash id (for prefixed custom types).
custom-readers
extend-freeze
macro
(extend-freeze type custom-type-id [x out] & body)
Extends Nippy to support freezing of a custom type (ideally concrete) with
+increased danger if a key is somehow compromised.
custom-readers
default-freeze-compressor-selector
(default-freeze-compressor-selector ba)
Strategy:
+* Prioritize speed, but allow lz4.
+* Skip lz4 unless it's likely that lz4's space benefit will outweigh its
+  space overhead.
default-freeze-compressor-selector_
EXPERIMENTAL.
+Determines the global default default compressor selector
+(fn [^bytes ba])->compressor used by `(freeze <x> {:compressor :auto <...>}).
extend-freeze
macro
(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.
   * Byte ∈[1, 128] - no overhead, subject to id collisions.
@@ -53,14 +57,14 @@ given id of form:
 ;; or
 (extend-thaw 1 [data-input] ; Byte id
   (->MyType (.readUTF data-input)))
Freezable
protocol
Be careful about extending to interfaces, Ref. http://goo.gl/6gGRlU.
-
members
freeze-to-out*
(freeze-to-out* this out)
freezable?
(freezable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])
Alpha - subject to change, may be buggy!
+
members
freeze-to-out*
(freeze-to-out* this out)
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).
freeze
(freeze x & [{:keys [compressor encryptor password skip-header?], :or {compressor lz4-compressor, encryptor aes128-encryptor}, :as opts}])
Serializes arg (any Clojure data type) to a byte array. To freeze custom
+pre/post serialization equality (there's no good general way of doing so).
freeze
(freeze x & [{:keys [compressor encryptor password skip-header?], :or {compressor :auto, encryptor aes128-encryptor}, :as opts}])
Serializes arg (any Clojure data type) to a byte array. To freeze custom
 types, extend the Clojure reader or see `extend-freeze`.
freeze-fallback-as-str
(freeze-fallback-as-str x out)
Alpha-subject to change.
 
freeze-to-out!
(freeze-to-out! data-output x & _)
Low-level API. Serializes arg (any Clojure data type) to a DataOutput.
 
freeze-to-stream!
DEPRECATED: Use `freeze-to-out!` instead.
@@ -80,8 +84,8 @@ Write speed: _very_ slow (also currently single-threaded).
  Read speed: slow.
 
 A specialized compressor for large, low-write data in space-sensitive
-environments.
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.
+environments.
map->Compressable-LZMA2
(map->Compressable-LZMA2 m__6249__auto__)
Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
+
map->StressRecord
(map->StressRecord m__6249__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)
read-utf8
macro
(read-utf8 in & [small?])
snappy-compressor
Default org.iq80.snappy.Snappy compressor:
       Ratio: low.
 Write speed: very high.
@@ -90,7 +94,7 @@ Write speed: very high.
 A good general-purpose compressor.
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 [compressor encryptor password], :or {compressor :auto, encryptor :auto}, :as opts}])
Deserializes a frozen object from given byte array to its original Clojure
+
thaw
(thaw ba & [{:keys [compressor encryptor password v1-compatibility?], :or {compressor :auto, encryptor :auto, v1-compatibility? true}, :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. To thaw custom types, extend the Clojure reader or see `extend-thaw`.
 
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 11962c6..e021168 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,8 +1,8 @@
 
-taoensso.nippy.tools documentation
taoensso.nippy.tools
Utilities for third-party tools that want to add fully-user-configurable
+taoensso.nippy.tools documentation
taoensso.nippy.tools
Utilities for third-party tools that want to add fully-user-configurable
 Nippy support. Used by Carmine and Faraday.
*thaw-opts*
dynamic
->WrappedForFreezing
(->WrappedForFreezing value opts)
Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
 
freeze
(freeze x & [{:keys [default-opts]}])
Like `nippy/freeze` but takes options from special argument wrapper when
-present.
map->WrappedForFreezing
(map->WrappedForFreezing m__5869__auto__)
Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
+present.
map->WrappedForFreezing
(map->WrappedForFreezing m__6249__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.
 
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 eff6d95..21dc86e 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy.utils documentation
taoensso.nippy.utils
freezable?
(freezable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])
Alpha - subject to change, may be buggy!
+taoensso.nippy.utils documentation
taoensso.nippy.utils
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.