diff --git a/index.html b/index.html index 6a4eccd..9b4a043 100644 --- a/index.html +++ b/index.html @@ -1,8 +1,8 @@ -Nippy 2.5.0 API documentation

Nippy 2.5.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.
+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.
 
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 81b9843..a1f8f73 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? 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 484a332..e3aa6f8 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 90cff1c..c1acedc 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 01488a0..86d322b 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,25 +1,38 @@
 
-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.
+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.
 
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.
+
custom-readers
extend-freeze
macro
(extend-freeze type custom-type-id [x out] & 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.
+(extend-freeze MyType 1 [x data-output]
+  (.writeUTF [data-output] (:data x)))
extend-thaw
macro
(extend-thaw custom-type-id [in] & body)
Alpha - subject to change.
 Extends Nippy to support thawing of a custom type with id ∈[1, 128]:
-(extend-thaw 1 [data-input-stream]
-  (->MyType (.readUTF data-input-stream)))
freeze
(freeze x & [{:keys [password compressor encryptor legacy-mode], :or {compressor snappy-compressor, encryptor aes128-encryptor}}])
Serializes arg (any Clojure data type) to a byte array. Set :legacy-mode to
-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->Compressable-LZMA2
(map->Compressable-LZMA2 m__5665__auto__)
Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
+(extend-thaw 1 [data-input]
+  (->MyType (.readUTF data-input)))
freeze
(freeze x & [{:keys [password compressor encryptor skip-header?], :or {compressor snappy-compressor, encryptor aes128-encryptor}, :as opts}])
Serializes arg (any Clojure data type) to a byte array. For 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-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.
-
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.
-
thaw-from-stream!
(thaw-from-stream! data-input-stream & _)
Low-level API. Deserializes a frozen object from given DataInputStream to its
-original Clojure data type.
write-id
macro
(write-id s id)

\ No newline at end of file
+
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
+data type. By default[1] supports data frozen with current and all previous
+versions of Nippy. For custom types extend the Clojure reader or see
+`extend-thaw`.
+
+[1] :headerless-meta provides a fallback facility for data frozen without a
+standard Nippy header (notably all Nippy v1 data). A default is provided for
+Nippy v1 thaw compatibility, but it's recommended that you _disable_ this
+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
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 2d881b7..92e5305 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 d0530ac..67b6310 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,7 +1,7 @@
 
-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.
-
case-eval
macro
(case-eval e & clauses)
Like `case` but evaluates test constants for their compile-time value.
+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.
repeatedly-into
macro
(repeatedly-into coll n & body)
Like `repeatedly` but faster and `conj`s items into given collection.
-
time-ns
macro
(time-ns & body)
Returns number of nanoseconds it takes to execute body.
+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