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:
- *final-freeze-fallback*
- ->Compressable-LZMA2
- ->StressRecord
- Freezable
- custom-readers
- extend-freeze
- extend-thaw
- freeze
- freeze-fallback-as-str
- freeze-to-bytes
- freeze-to-out!
- freeze-to-out*
- freeze-to-stream!
- freezeable?
- 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
- map->Compressable-LZMA2
- map->StressRecord
- read-biginteger
- read-bytes
- read-compact-long
- read-utf8
- stress-data
- stress-data-benchable
- stress-data-comparable
- thaw
- thaw-from-bytes
- thaw-from-in!
- thaw-from-stream!
- when-debug-mode
- write-biginteger
- write-bytes
- write-compact-long
- write-id
- write-utf8
taoensso.nippy.benchmarks
Public variables and functions:
taoensso.nippy.compression
Alpha - subject to change. +Nippy 2.6.0 API documentation Generated by Codox
Nippy 2.6.0 API documentation
Nippy 2.6.0 API documentation
Clojure serialization librarytaoensso.nippy
Simple, high-performance Clojure serialization library. Originally adapted +from Deep-Freeze.Public variables and functions:
- *final-freeze-fallback*
- ->Compressable-LZMA2
- ->StressRecord
- Freezable
- custom-readers
- extend-freeze
- extend-thaw
- freezable?
- freeze
- freeze-fallback-as-str
- freeze-to-bytes
- freeze-to-out!
- freeze-to-out*
- freeze-to-stream!
- 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
- map->Compressable-LZMA2
- map->StressRecord
- read-biginteger
- read-bytes
- read-compact-long
- read-utf8
- stress-data
- stress-data-benchable
- stress-data-comparable
- thaw
- thaw-from-bytes
- thaw-from-in!
- thaw-from-stream!
- when-debug-mode
- write-biginteger
- write-bytes
- write-compact-long
- write-id
- write-utf8
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.Public variables and functions:
taoensso.nippy.tools
Alpha - subject to change. diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index 2fcfea4..7422325 100644 --- a/taoensso.nippy.benchmarks.html +++ b/taoensso.nippy.benchmarks.html @@ -1,2 +1,2 @@ -taoensso.nippy.benchmarks documentation Generated by Codox
Nippy 2.6.0-RC1 API documentation
\ No newline at end of file +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)taoensso.nippy.benchmarks documentation Generated by Codox
Nippy 2.6.0 API documentation
\ No newline at end of file diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html index 393945d..ca27a78 100644 --- a/taoensso.nippy.compression.html +++ b/taoensso.nippy.compression.html @@ -1,5 +1,5 @@ -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)taoensso.nippy.compression documentation Generated by Codox
Nippy 2.6.0-RC1 API documentation
taoensso.nippy.compression documentation
Alpha - subject to change. +taoensso.nippy.compression documentation Generated by Codox
Nippy 2.6.0 API 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 da37ba3..3be808f 100644 --- a/taoensso.nippy.encryption.html +++ b/taoensso.nippy.encryption.html @@ -1,5 +1,5 @@ -taoensso.nippy.encryption documentation Generated by Codox
Nippy 2.6.0-RC1 API documentation
taoensso.nippy.encryption documentation
Alpha - subject to change. +taoensso.nippy.encryption documentation Generated by Codox
Nippy 2.6.0 API 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 3ffce1b..02bbe97 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,5 +1,5 @@ -taoensso.nippy documentation Generated by Codox
Nippy 2.6.0-RC1 API documentation
taoensso.nippy documentation
Simple, high-performance Clojure serialization library. Originally adapted +taoensso.nippy documentation Generated by Codox
Nippy 2.6.0 API 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. @@ -12,19 +12,19 @@ id ∈[1, 128]: (.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] - (->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. -freezeable?
(freezeable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])Alpha - subject to change, may be buggy! + (->MyType (.readUTF data-input)))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).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. +pre/post serialization equality (there's no good general way of doing so).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-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! diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html index cdccd78..fe1a2ab 100644 --- a/taoensso.nippy.tools.html +++ b/taoensso.nippy.tools.html @@ -1,5 +1,5 @@ -taoensso.nippy.tools documentation Generated by Codox
Nippy 2.6.0-RC1 API documentation
taoensso.nippy.tools documentation
Alpha - subject to change. +taoensso.nippy.tools documentation Generated by Codox
Nippy 2.6.0 API 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 a6511a4..2710d61 100644 --- a/taoensso.nippy.utils.html +++ b/taoensso.nippy.utils.html @@ -1,5 +1,5 @@ -taoensso.nippy.utils documentation Generated by Codox
Nippy 2.6.0-RC1 API documentation
taoensso.nippy.utils documentation
freezable?
(freezable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])Alpha - subject to change, may be buggy! +taoensso.nippy.utils documentation Generated by Codox
Nippy 2.6.0 API 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.