diff --git a/index.html b/index.html index 03e74a2..11b5d48 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Nippy 2.12.0-beta1

Project

Namespaces

Nippy 2.12.0-beta1

High-performance serialization library for Clojure.

Installation

To install, add the following dependency to your project or build file:

[com.taoensso/nippy "2.12.0-beta1"]

Namespaces

taoensso.nippy

High-performance serialization library for Clojure

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
Public variables and functions:
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support.
+Nippy 2.12.0-RC1
Project
Namespaces
Nippy 2.12.0-RC1
High-performance serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "2.12.0-RC1"]
Namespaces
taoensso.nippy
High-performance serialization library for Clojure
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
Public variables and functions:
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support.
 Used by Carmine, Faraday, etc.
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 d686f4f..fe93680 100644
--- a/taoensso.nippy.benchmarks.html
+++ b/taoensso.nippy.benchmarks.html
@@ -1,3 +1,3 @@
 
-taoensso.nippy.benchmarks documentation
Project
Namespaces
Public Vars
taoensso.nippy.benchmarks
bench
(bench {:keys [reader? lzma2? fressian? laps], :or {laps 1}})
view source
bench*
macro
(bench* & body)
view source
bench1
(bench1 freezer thawer & [sizer])
view source
fressian-freeze
(fressian-freeze value)
view source
fressian-thaw
(fressian-thaw value)
view source

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

\ No newline at end of file
diff --git a/taoensso.nippy.compression.html b/taoensso.nippy.compression.html
index b0e2aa1..0409373 100644
--- a/taoensso.nippy.compression.html
+++ b/taoensso.nippy.compression.html
@@ -1,6 +1,6 @@
 
-taoensso.nippy.compression documentation
Project
Namespaces
Public Vars
taoensso.nippy.compression
->LZ4Compressor
(->LZ4Compressor compressor decompressor)
Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
+taoensso.nippy.compression documentation
Project
Namespaces
Public Vars
taoensso.nippy.compression
->LZ4Compressor
(->LZ4Compressor compressor decompressor)
Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
 
view source
->LZMA2Compressor
(->LZMA2Compressor compression-level)
Positional factory function for class taoensso.nippy.compression.LZMA2Compressor.
 
view source
->SnappyCompressor
(->SnappyCompressor)
Positional factory function for class taoensso.nippy.compression.SnappyCompressor.
 
view source
ICompressor
protocol
members
compress
(compress compressor ba)
decompress
(decompress compressor ba)
header-id
(header-id compressor)
view source
lz4-compressor
Default net.jpountz.lz4 compressor:
diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html
index 39b1b15..6732a2c 100644
--- a/taoensso.nippy.encryption.html
+++ b/taoensso.nippy.encryption.html
@@ -1,6 +1,6 @@
 
-taoensso.nippy.encryption documentation
Project
Namespaces
Public Vars
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults
+taoensso.nippy.encryption documentation
Project
Namespaces
Public Vars
taoensso.nippy.encryption
Simple no-nonsense crypto with reasonable defaults
 
->AES128Encryptor
(->AES128Encryptor header-id keyfn cached-keyfn)
Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
 
view source
aes128-encryptor
Default 128bit AES encryptor with many-round SHA-512 key-gen.
 
@@ -35,6 +35,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.
view source
IEncryptor
protocol
members
decrypt
(decrypt encryptor pwd ba)
encrypt
(encrypt encryptor pwd ba)
header-id
(header-id encryptor)
view source
map->AES128Encryptor
(map->AES128Encryptor m__8448__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.
view source
IEncryptor
protocol
members
decrypt
(decrypt encryptor pwd ba)
encrypt
(encrypt encryptor pwd ba)
header-id
(header-id encryptor)
view source
map->AES128Encryptor
(map->AES128Encryptor m__8454__auto__)
Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
 
view source
standard-header-ids
These'll support :auto thaw
 
view source

\ No newline at end of file
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index c769359..e2332d5 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,13 +1,13 @@
 
-taoensso.nippy documentation
Project
Namespaces
Public Vars
taoensso.nippy
High-performance serialization library for Clojure
+taoensso.nippy documentation
Project
Namespaces
Public Vars
taoensso.nippy
High-performance serialization library for Clojure
 
*auto-freeze-compressor*
dynamic
(fn [byte-array])->compressor used by `(freeze <x> {:compressor :auto}),
 nil => default
view source
*custom-readers*
dynamic
{<hash-or-byte-id> (fn [data-input])}
 
view source
*final-freeze-fallback*
dynamic
DEPRECATED
-
view source
*freeze-fallback*
dynamic
(fn [data-output x]), nil => default
+
view source
*freeze-fallback*
dynamic
(fn [data-output x]), nil => default
 
view source
->CacheWrapped
(->CacheWrapped value)
Positional factory function for class taoensso.nippy.CacheWrapped.
-
view source
->StressRecord
(->StressRecord data)
Positional factory function for class taoensso.nippy.StressRecord.
-
view source
aes128-encryptor
Default 128bit AES encryptor with many-round SHA-512 key-gen.
+
view source
->StressRecord
(->StressRecord data)
Positional factory function for class taoensso.nippy.StressRecord.
+
view source
aes128-encryptor
Default 128bit AES encryptor with many-round SHA-512 key-gen.
 
 Password form [:salted "my-password"]
 ---------------------------------------
@@ -44,7 +44,7 @@ increased danger if a key is somehow compromised.
view source
compress
(compress compressor ba)
view source
decompress
(decompress compressor ba)
view source
decrypt
(decrypt encryptor pwd ba)
view source
encrypt
(encrypt encryptor pwd ba)
view source
extend-freeze
macro
(extend-freeze type custom-type-id [x out] & body)
Extends Nippy to support freezing of a custom type (ideally concrete) with
+  will incl. a single "foo", plus 2x single-byte references to "foo".
view source
compress
(compress compressor ba)
view source
decompress
(decompress compressor ba)
view source
decrypt
(decrypt encryptor pwd ba)
view source
encrypt
(encrypt encryptor pwd ba)
view source
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
   * Integer ∈[1, 128] - no overhead, subject to id collisions
@@ -54,23 +54,23 @@ given id of form:
   (.writeUTF [data-output] (:data x)))
 ;; or
 (extend-freeze MyType 1 [x data-output] ; Byte id
-  (.writeUTF [data-output] (:data x)))
view source
extend-thaw
macro
(extend-thaw custom-type-id [in] & body)
Extends Nippy to support thawing of a custom type with given id:
+  (.writeUTF [data-output] (:data x)))
view source
extend-thaw
macro
(extend-thaw custom-type-id [in] & body)
Extends Nippy to support thawing of a custom type with given id:
 (extend-thaw :foo/my-type [data-input] ; Keyword id
-  (->MyType (.readUTF data-input)))
+  (MyType. (.readUTF data-input)))
 ;; or
 (extend-thaw 1 [data-input] ; Byte id
-  (->MyType (.readUTF data-input)))
view source
fast-freeze
(fast-freeze x)
Like `freeze` but:
+  (MyType. (.readUTF data-input)))
view source
fast-freeze
(fast-freeze x)
Like `freeze` but:
   - Writes data without a Nippy header
   - Drops all support for compression and encryption
   - Must be thawed with `fast-thaw`
 
 Equivalent to (but a little faster than):
-  `(freeze x {:compressor nil :encryptor nil :no-header? true})
view source
fast-thaw
(fast-thaw ba)
Like `thaw` but:
+  `(freeze x {:compressor nil :encryptor nil :no-header? true})
view source
fast-thaw
(fast-thaw ba)
Like `thaw` but:
   - Drops all support for compression and encryption
   - Supports only data frozen with `fast-freeze`
 
 Equivalent to (but a little faster than):
-  `(thaw x {:compressor nil :encryptor nil :no-header? true})
view source
Freezable
protocol
Implementation detail. Be careful about extending to interfaces,
+  `(thaw x {:compressor nil :encryptor nil :no-header? true})
view source
Freezable
protocol
Implementation detail. Be careful about extending to interfaces,
 Ref. http://goo.gl/6gGRlU.
members
-freeze-to-out!
(-freeze-to-out! this out)
view source
freezable?
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})
Alpha - subject to change.
 Returns truthy iff Nippy *appears* to support freezing the given argument.
 
@@ -79,10 +79,10 @@ used to 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 value equality (there's no good general
 way of doing so).
view source
freeze
(freeze x)(freeze x {:keys [compressor encryptor password], :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`.
view source
freeze-fallback-as-str
DEPRECATED
-
view source
freeze-to-out!
(freeze-to-out! data-output x)
Serializes arg (any Clojure data type) to a DataOutput. Please note that
-this is a low-level util: in most cases you'll want `freeze` instead.
view source
inspect-ba
(inspect-ba ba)(inspect-ba ba thaw-opts)
Alpha - subject to change
-
view source
lz4-compressor
Default net.jpountz.lz4 compressor:
+types, extend the Clojure reader or see `extend-freeze`.
view source
freeze-fallback-as-str
DEPRECATED
+
view source
freeze-to-out!
(freeze-to-out! data-output x)
Serializes arg (any Clojure data type) to a DataOutput. Please note that
+this is a low-level util: in most cases you'll want `freeze` instead.
view source
inspect-ba
(inspect-ba ba)(inspect-ba ba thaw-opts)
Alpha - subject to change
+
view source
lz4-compressor
Default net.jpountz.lz4 compressor:
       Ratio: low.
 Write speed: very high.
  Read speed: very high.
@@ -97,17 +97,17 @@ Write speed: _very_ slow (also currently single-threaded).
  Read speed: slow.
 
 A specialized compressor for large, low-write data in space-sensitive
-environments.
view source
map->CacheWrapped
(map->CacheWrapped m__8448__auto__)
Factory function for class taoensso.nippy.CacheWrapped, taking a map of keywords to field values.
-
view source
map->StressRecord
(map->StressRecord m__8448__auto__)
Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
-
view source
set-auto-freeze-compressor!
(set-auto-freeze-compressor! x)
view source
set-freeze-fallback!
(set-freeze-fallback! x)
view source
snappy-compressor
Default org.iq80.snappy.Snappy compressor:
+environments.
view source
map->CacheWrapped
(map->CacheWrapped m__8454__auto__)
Factory function for class taoensso.nippy.CacheWrapped, taking a map of keywords to field values.
+
view source
map->StressRecord
(map->StressRecord m__8454__auto__)
Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
+
view source
set-auto-freeze-compressor!
(set-auto-freeze-compressor! x)
view source
set-freeze-fallback!
(set-freeze-fallback! x)
view source
snappy-compressor
Default org.iq80.snappy.Snappy compressor:
       Ratio: low.
 Write speed: very high.
  Read speed: very high.
 
 A good general-purpose compressor.
view source
stress-data
Reference data used for tests & benchmarks
-
view source
stress-data-benchable
Reference data with stuff removed that breaks reader or other utils we'll
-be benching against
view source
stress-data-comparable
Reference data with stuff removed that breaks roundtrip equality
-
view source
swap-custom-readers!
(swap-custom-readers! f)
view source
thaw
(thaw ba)(thaw ba {:keys [v1-compatibility? compressor encryptor password], :or {compressor :auto, encryptor :auto}, :as opts})
Deserializes a frozen Nippy byte array to its original Clojure data type.
+
view source
stress-data-benchable
Reference data with stuff removed that breaks reader or other utils we'll
+be benching against
view source
stress-data-comparable
Reference data with stuff removed that breaks roundtrip equality
+
view source
swap-custom-readers!
(swap-custom-readers! f)
view source
thaw
(thaw ba)(thaw ba {:keys [v1-compatibility? compressor encryptor password], :or {compressor :auto, encryptor :auto}, :as opts})
Deserializes a frozen Nippy byte array to its original Clojure data type.
 To thaw custom types, extend the Clojure reader or see `extend-thaw`.
 
 ** By default, supports data frozen with Nippy v2+ ONLY **
@@ -117,6 +117,6 @@ legacy versions of Nippy.
 Options include:
   :v1-compatibility? - support data frozen by legacy versions of Nippy?
   :compressor - :auto (checks header, default)  an ICompressor, or nil
-  :encryptor  - :auto (checks header, default), an IEncryptor,  or nil
view source
thaw-from-in!
(thaw-from-in! data-input)
Deserializes a frozen object from given DataInput to its original Clojure
+  :encryptor  - :auto (checks header, default), an IEncryptor,  or nil
view source
thaw-from-in!
(thaw-from-in! data-input)
Deserializes a frozen object from given DataInput to its original Clojure
 data type. Please note that this is a low-level util: in most cases you'll
-want `thaw` instead.
view source
throw-unfreezable
(throw-unfreezable x)
view source
try-write-readable
(try-write-readable out x)
view source
try-write-serializable
(try-write-serializable out x)
view source
write-id
macro
(write-id out id)
view source
write-unfreezable
(write-unfreezable out x)
view source

\ No newline at end of file
+want `thaw` instead.
view source
throw-unfreezable
(throw-unfreezable x)
view source
try-write-readable
(try-write-readable out x)
view source
try-write-serializable
(try-write-serializable out x)
view source
write-id
macro
(write-id out id)
view source
write-unfreezable
(write-unfreezable out x)
view source

\ No newline at end of file
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index abd09b2..d82b186 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,9 +1,9 @@
 
-taoensso.nippy.tools documentation
Project
Namespaces
Public Vars
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support.
+taoensso.nippy.tools documentation
Project
Namespaces
Public Vars
taoensso.nippy.tools
Utils for 3rd-party tools that want to add user-configurable Nippy support.
 Used by Carmine, Faraday, etc.
*freeze-opts*
dynamic
view source
*thaw-opts*
dynamic
view source
->WrappedForFreezing
(->WrappedForFreezing value opts)
Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
 
view source
freeze
(freeze x)(freeze x default-opts)
Like `nippy/freeze` but merges opts from *freeze-opts*, `wrap-for-freezing`.
-
view source
map->WrappedForFreezing
(map->WrappedForFreezing m__8448__auto__)
Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
+
view source
map->WrappedForFreezing
(map->WrappedForFreezing m__8454__auto__)
Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
 
view source
thaw
(thaw ba)(thaw ba default-opts)
Like `nippy/thaw` but merges opts  from `*thaw-opts*`.
 
view source
with-freeze-opts
macro
(with-freeze-opts opts & body)
view source
with-thaw-opts
macro
(with-thaw-opts opts & body)
view source
wrap-for-freezing
(wrap-for-freezing x)(wrap-for-freezing x opts)
Ensures that given arg (any freezable data type) is wrapped so that
 (tools/freeze <wrapped-arg>) will serialize as
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 8884c33..72e8f14 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,10 +1,10 @@
 
-taoensso.nippy.utils documentation
Project
Namespaces
Public Vars
taoensso.nippy.utils
freezable?
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})
Alpha - subject to change.
+taoensso.nippy.utils documentation
Project
Namespaces
Public Vars
taoensso.nippy.utils
freezable?
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})
Alpha - subject to change.
 Returns truthy iff Nippy *appears* to support freezing the given argument.
 
 `:allow-clojure-reader?` and `:allow-java-serializable?` options may be
 used to 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 value equality (there's no good general
-way of doing so).
view source
readable?
view source
serializable?
view source

\ No newline at end of file
+way of doing so).
view source
readable?
view source
serializable?
view source

\ No newline at end of file