diff --git a/index.html b/index.html index 00ed80e..a510e38 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -Nippy 2.10.0-beta1 API documentation

Nippy 2.10.0-beta1

Clojure serialization library

taoensso.nippy

High-performance JVM Clojure serialization library. Originally adapted from
-Deep-Freeze (https://goo.gl/OePPGr).

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.10.0 API documentation
Nippy 2.10.0
Clojure serialization library
taoensso.nippy
High-performance JVM Clojure serialization library. Originally adapted from
+Deep-Freeze (https://goo.gl/OePPGr).
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 5f2a797..b68d9b5 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 6252b79..0069022 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 5aa1a27..4eb7a81 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.
 
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index 8183518..ecd7431 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,5 +1,5 @@
 
-taoensso.nippy documentation
taoensso.nippy
High-performance JVM Clojure serialization library. Originally adapted from
+taoensso.nippy documentation
taoensso.nippy
High-performance JVM Clojure serialization library. Originally adapted from
 Deep-Freeze (https://goo.gl/OePPGr).
*custom-readers*
dynamic
{<hash-or-byte-id> (fn [data-input])}
 
*default-freeze-compressor-selector*
dynamic
(fn selector [^bytes ba])->compressor used by `(freeze <x> {:compressor :auto}).
 
*final-freeze-fallback*
dynamic
Alpha - subject to change.
@@ -64,11 +64,10 @@ 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 :auto, 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)(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.
-
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-prefixed-custom
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.
+
freeze-to-out!
(freeze-to-out! data-output x)
Low-level API. Serializes arg (any Clojure data type) to a DataOutput.
+
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-depr1
id-keyword-small
id-list
id-long
id-map
id-map-depr1
id-meta
id-nil
id-prefixed-custom
id-queue
id-ratio
id-reader
id-reader-depr1
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-depr1
id-string-small
id-uuid
id-vector
inspect-ba
(inspect-ba ba & [thaw-opts])
Alpha - subject to change.
 
lz4-compressor
Default net.jpountz.lz4 compressor:
       Ratio: low.
 Write speed: very high.
@@ -95,13 +94,12 @@ 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.
-
swap-custom-readers!
(swap-custom-readers! f)
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
+
swap-custom-readers!
(swap-custom-readers! f)
thaw
(thaw ba)(thaw ba {:keys [v1-compatibility? compressor encryptor password], :or {v1-compatibility? true, compressor :auto, encryptor :auto}, :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`.
 
 Options include:
   :compressor - An ICompressor, :auto (requires Nippy header), or nil.
-  :encryptor  - An IEncryptor,  :auto (requires Nippy header), or nil.
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-biginteger
macro
(write-biginteger out x)
write-bytes
macro
(write-bytes out ba & [small?])
write-compact-long
macro
(write-compact-long out x)
Uses 2->9 bytes.
+  :encryptor  - An IEncryptor,  :auto (requires Nippy header), or nil.
thaw-from-in!
(thaw-from-in! data-input)
Low-level API. Deserializes a frozen object from given DataInput to its
+original Clojure data type.
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)
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 21dfc17..7622323 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,5 +1,5 @@
 
-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__6289__auto__)
Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 635b5bf..fdf631a 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.