diff --git a/index.html b/index.html index 77f038d..39efe00 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Nippy 2.13.0-RC1

Project

Namespaces

Nippy 2.13.0-RC1

Released under the Eclipse Public License

High-performance serialization library for Clojure.

Installation

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

[com.taoensso/nippy "2.13.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.
+Nippy 2.13.0
Project
Namespaces
Nippy 2.13.0
Released under the Eclipse Public License
High-performance serialization library for Clojure.
Installation
To install, add the following dependency to your project or build file:
[com.taoensso/nippy "2.13.0"]
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 41a040d..9f96d8c 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 86728fc..c52b48a 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
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:
+taoensso.nippy.compression documentation
Project
Namespaces
Public Vars
taoensso.nippy.compression
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:
       Ratio: low.
 Write speed: very high.
  Read speed: very high.
diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html
index 7ecfdf9..35bdecc 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
 
aes128-encryptor
Default 128bit AES encryptor with many-round SHA-512 key-gen.
 
 Password form [:salted "my-password"]
diff --git a/taoensso.nippy.html b/taoensso.nippy.html
index 6a30b54..ad2ab4c 100644
--- a/taoensso.nippy.html
+++ b/taoensso.nippy.html
@@ -1,12 +1,12 @@
 
-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
-cache-proxy
{[<x> <meta>] <idx>} for freezing, {<idx> <x-with-meta>} for thawing.
-
view source
aes128-encryptor
Default 128bit AES encryptor with many-round SHA-512 key-gen.
+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
-cache-proxy
{[<x> <meta>] <idx>} for freezing, {<idx> <x-with-meta>} for thawing.
+
view source
aes128-encryptor
Default 128bit AES encryptor with many-round SHA-512 key-gen.
 
 Password form [:salted "my-password"]
 ---------------------------------------
@@ -39,13 +39,13 @@ 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
cache
(cache x)
Experimental, subject to change.
+increased danger if a key is somehow compromised.
view source
cache
(cache x)
Experimental, subject to change.
 
 Wraps value so that future writes of the same wrapped value with same
 metadata will be efficiently encoded as references to this one.
 
 (freeze [(cache "foo") (cache "foo") (cache "foo")])
-  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
+  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
@@ -57,34 +57,37 @@ NB: be careful about extending to interfaces, Ref. 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
   (MyRec. (.readUTF data-input)))
 ;; or
 (extend-thaw 1 [data-input] ; Byte id
-  (MyRec. (.readUTF data-input)))
view source
fast-freeze
(fast-freeze x)
Like `freeze` but:
+  (MyRec. (.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?
(freezable? x)(freezable? x {:keys [allow-clojure-reader? allow-java-serializable?]})
Alpha - subject to change.
+  `(thaw x {:compressor nil :encryptor nil :no-header? true})
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.
 
 `: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
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.
-This is a low-level util: in most cases you'll want `freeze` instead.
view source
IFreezable1
protocol
members
-freeze-without-meta!
(-freeze-without-meta! x data-output)
view source
IFreezable2
protocol
members
-freeze-with-meta!
(-freeze-with-meta! x data-output)
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:
+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-file
(freeze-to-file file x)(freeze-to-file file x freeze-opts)
Convenience util: writes `(freeze x freeze-opts)` byte array to
+`(clojure.java.io/file file)` and returns the byte array.
+
+(freeze-to-file "my-filename.npy" my-val) => Serialized byte array
view source
freeze-to-out!
(freeze-to-out! data-output x)
Serializes arg (any Clojure data type) to a DataOutput.
+This is a low-level util: in most cases you'll want `freeze` instead.
view source
IFreezable1
protocol
members
-freeze-without-meta!
(-freeze-without-meta! x data-output)
view source
IFreezable2
protocol
members
-freeze-with-meta!
(-freeze-with-meta! x data-output)
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.
@@ -92,22 +95,22 @@ Write speed: very high.
 A good general-purpose compressor, competitive with Snappy.
 
 Thanks to Max Penet (@mpenet) for our first implementation,
-Ref. https://github.com/mpenet/nippy-lz4
view source
lz4hc-compressor
Like `lz4-compressor` but trades some write speed for ratio.
-
view source
lzma2-compressor
Default org.tukaani.xz.LZMA2 compressor:
+Ref. https://github.com/mpenet/nippy-lz4
view source
lz4hc-compressor
Like `lz4-compressor` but trades some write speed for ratio.
+
view source
lzma2-compressor
Default org.tukaani.xz.LZMA2 compressor:
       Ratio: high.
 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
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
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.
+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.
 To thaw custom types, extend the Clojure reader or see `extend-thaw`.
 
 ** By default, supports data frozen with Nippy v2+ ONLY **
@@ -117,7 +120,13 @@ 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-file
(thaw-from-file file)(thaw-from-file file thaw-opts)
Convenience util: returns `(thaw ba thaw-opts)` Clojure value for the
+byte array read from `(clojure.java.io/file file)`.
+
+(thaw-from-file "my-filename.npy") => Deserialized Clojure value
+
+To thaw from a resource on classpath (e.g in Leiningen `resources` dir):
+  (thaw-from-file (clojure.java.io/resource "my-resource-name.npy"))
view source
thaw-from-in!
(thaw-from-in! data-input)
Deserializes a frozen object from given DataInput to its original Clojure
 data type.
 
-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
+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
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 97b89e7..fdb4e7b 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,6 +1,6 @@
 
-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
freeze
(freeze x)(freeze x default-opts)
Like `nippy/freeze` but merges opts from *freeze-opts*, `wrap-for-freezing`.
 
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
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index 30fbe4d..684d95f 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,6 +1,6 @@
 
-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