diff --git a/css/default.css b/css/default.css index fcabf4e..932f18c 100644 --- a/css/default.css +++ b/css/default.css @@ -9,11 +9,21 @@ pre, code { margin: 15px 0; } -h2 { +h1 { font-weight: normal; font-size: 28px; - padding: 10px 0 2px 0; - margin: 0; + margin: 10px 0 2px 0; + padding: 0; +} + +h2 { + font-weight: normal; + font-size: 25px; +} + +.document h1, .namespace-index h1 { + font-size: 30px; + margin-top: 12px; } #header, #content, .sidebar { @@ -24,14 +34,13 @@ h2 { top: 0; left: 0; right: 0; - height: 20px; - background: #444; - color: #fff; + height: 22px; + color: #f5f5f5; padding: 5px 7px; } #content { - top: 30px; + top: 32px; right: 0; bottom: 0; overflow: auto; @@ -42,58 +51,66 @@ h2 { .sidebar { position: fixed; - top: 30px; + top: 32px; bottom: 0; overflow: auto; } -#namespaces { +.sidebar.primary { background: #e2e2e2; border-right: solid 1px #cccccc; left: 0; width: 250px; } -#vars { +.sidebar.secondary { background: #f2f2f2; border-right: solid 1px #cccccc; left: 251px; width: 200px; } -.namespace-index { +#content.namespace-index, #content.document { left: 251px; } -.namespace-docs { +#content.namespace-docs { left: 452px; } +#content.document { + padding-bottom: 10%; +} + #header { - background: -moz-linear-gradient(top, #555 0%, #222 100%); - background: -webkit-linear-gradient(top, #555 0%, #333 100%); - background: -o-linear-gradient(top, #555 0%, #222 100%); - background: -ms-linear-gradient(top, #555 0%, #222 100%); - background: linear-gradient(top, #555 0%, #222 100%); - box-shadow: 0 0 8px rgba(0, 0, 0, 0.4); - z-index: 100; + background: #3f3f3f; + box-shadow: 0 0 8px rgba(0, 0, 0, 0.4); + z-index: 100; } #header h1 { margin: 0; padding: 0; - font-size: 12pt; + font-size: 18px; font-weight: lighter; text-shadow: -1px -1px 0px #333; } +#header h1 .project-version { + font-weight: normal; +} + +.project-version { + padding-left: 5px; +} + #header a, .sidebar a { display: block; text-decoration: none; } #header a { - color: #fff; + color: #f5f5f5; } .sidebar a { @@ -104,7 +121,7 @@ h2 { float: right; font-size: 9pt; font-weight: normal; - margin: 3px 3px; + margin: 4px 3px; padding: 0; color: #bbb; } @@ -120,11 +137,20 @@ h2 { font-weight: normal; } +.sidebar h3.no-link { + color: #636363; + font-weight: lighter; +} + .sidebar ul { - padding: 0.5em 0em; + padding: 7px 0 6px 0; margin: 0; } +.sidebar ul.index-link { + padding-bottom: 4px; +} + .sidebar li { display: block; vertical-align: middle; @@ -193,18 +219,37 @@ h2 { border-left: 1px solid #aaa; } -#namespaces li.current a { +.sidebar.primary li.current a { border-left: 3px solid #a33; color: #a33; } -#vars li.current a { +.sidebar.secondary li.current a { border-left: 3px solid #33a; color: #33a; } -#content h3 { - font-size: 13pt; +.namespace-index h2 { + margin: 30px 0 0 0; +} + +.namespace-index h3 { + font-size: 16px; + font-weight: bold; + margin-bottom: 0; +} + +.namespace-index .topics { + padding-left: 30px; + margin: 11px 0 0 0; +} + +.namespace-index .topics li { + padding: 5px 0; +} + +.namespace-docs h3 { + font-size: 18px; font-weight: bold; } @@ -375,10 +420,26 @@ p { } .markdown { - line-height: 18px; font-size: 14px; } +.markdown p, .markdown li, .markdown dt, .markdown dd, .markdown td { + line-height: 18px; +} + +.markdown h2 { + font-weight: normal; + font-size: 25px; +} + +#content .markdown h3 { + font-size: 20px; +} + +.markdown h4 { + font-size: 15px; +} + .doc, .public, .namespace .index { max-width: 680px; overflow-x: visible; @@ -452,4 +513,4 @@ p { padding: 1px 4px; text-decoration: none; color: #5555bb; -} \ No newline at end of file +} diff --git a/index.html b/index.html index a510e38..01fbaad 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ -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).

taoensso.nippy.benchmarks

Public variables and functions:

taoensso.nippy.compression

taoensso.nippy.encryption

Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
+Nippy 2.11.0-SNAPSHOT

Nippy 2.11.0-SNAPSHOT

Clojure serialization library

Namespaces

taoensso.nippy

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

taoensso.nippy.encryption

Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
 deserves some privacy.

taoensso.nippy.tools

Utilities for third-party tools that want to add fully-user-configurable
 Nippy support. Used by Carmine and Faraday.

taoensso.nippy.utils

Public variables and functions:

\ No newline at end of file diff --git a/js/page_effects.js b/js/page_effects.js index ef8120d..28bdfc8 100644 --- a/js/page_effects.js +++ b/js/page_effects.js @@ -31,15 +31,15 @@ function scrollToCurrentVarLink(elements) { } function setCurrentVarLink() { - $('#vars a').parent().removeClass('current') + $('.secondary a').parent().removeClass('current') $('.anchor'). filter(function(index) { return visibleInParent(this) }). each(function(index, element) { - findLinkByFragment("#vars a", element.id). + findLinkByFragment(".secondary a", element.id). parent(). addClass('current') }); - scrollToCurrentVarLink('#vars .current'); + scrollToCurrentVarLink('.secondary .current'); } var hasStorage = (function() { try { return localStorage.getItem } catch(e) {} }()) @@ -72,27 +72,32 @@ function sidebarContentWidth(element) { } function resizeSidebars() { - var nsWidth = sidebarContentWidth('#namespaces') + 30 - var varWidth = 0 + var primaryWidth = sidebarContentWidth('.primary') + 30 + var secondaryWidth = 0 - if ($('#vars').length != 0) { - varWidth = sidebarContentWidth('#vars') + 30 + if ($('.secondary').length != 0) { + secondaryWidth = sidebarContentWidth('.secondary') + 30 } // snap to grid - var snap = 30; - nsWidth = Math.ceil(nsWidth / snap) * snap; - varWidth = Math.ceil(varWidth / snap) * snap; + var snap = 30 + primaryWidth = Math.ceil(primaryWidth / snap) * snap + secondaryWidth = Math.ceil(secondaryWidth / snap) * snap - $('#namespaces').css('width', nsWidth) - $('#vars').css('width', varWidth) - $('#vars, .namespace-index').css('left', nsWidth + 1) - $('.namespace-docs').css('left', nsWidth + varWidth + 2) + $('.primary').css('width', primaryWidth) + $('.secondary').css('width', secondaryWidth).css('left', primaryWidth + 1) + + if (secondaryWidth > 0) { + $('#content').css('left', primaryWidth + secondaryWidth + 2) + } + else { + $('#content').css('left', primaryWidth + 1) + } } $(window).ready(resizeSidebars) $(window).ready(setCurrentVarLink) -$(window).ready(function() { persistScrollPosition('#namespaces')}) +$(window).ready(function() { persistScrollPosition('.primary')}) $(window).ready(function() { $('#content').scroll(setCurrentVarLink) $(window).resize(setCurrentVarLink) diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index b68d9b5..7d4d7c6 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])

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 0069022..d26698a 100644 --- a/taoensso.nippy.compression.html +++ b/taoensso.nippy.compression.html @@ -1,8 +1,8 @@ -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:
+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:
       Ratio: low.
 Write speed: very high.
  Read speed: very high.
@@ -10,17 +10,17 @@ 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

lz4hc-compressor

Like `lz4-compressor` but trades some write speed for ratio.
-

lzma2-compressor

Default org.tukaani.xz.LZMA2 compressor:
+Ref. https://github.com/mpenet/nippy-lz4

lz4hc-compressor

Like `lz4-compressor` but trades some write speed for ratio.
+

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.

snappy-compressor

Default org.iq80.snappy.Snappy compressor:
+environments.

snappy-compressor

Default org.iq80.snappy.Snappy compressor:
       Ratio: low.
 Write speed: very high.
  Read speed: very high.
 
-A good general-purpose compressor.

standard-header-ids

These'll support :auto thaw.
-
\ No newline at end of file +A good general-purpose compressor.

standard-header-ids

These'll support :auto thaw.
+
\ No newline at end of file diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html index 4eb7a81..78ca9c6 100644 --- a/taoensso.nippy.encryption.html +++ b/taoensso.nippy.encryption.html @@ -1,7 +1,7 @@ -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.
+

aes128-encryptor

Default 128bit AES encryptor with multi-round SHA-512 key-gen.
 
 Password form [:salted "my-password"]
 ---------------------------------------
@@ -34,6 +34,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.

IEncryptor

protocol

members

decrypt

(decrypt encryptor pwd ba)

encrypt

(encrypt encryptor pwd ba)

header-id

(header-id encryptor)

map->AES128Encryptor

(map->AES128Encryptor m__6289__auto__)
Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
-

standard-header-ids

These'll support :auto thaw.
-
\ No newline at end of file +increased danger if a key is somehow compromised.

IEncryptor

protocol

members

decrypt

(decrypt encryptor pwd ba)

encrypt

(encrypt encryptor pwd ba)

header-id

(header-id encryptor)

map->AES128Encryptor

(map->AES128Encryptor m__6289__auto__)
Factory function for class taoensso.nippy.encryption.AES128Encryptor, taking a map of keywords to field values.
+

standard-header-ids

These'll support :auto thaw.
+
\ No newline at end of file diff --git a/taoensso.nippy.html b/taoensso.nippy.html index ecd7431..213a8da 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,11 +1,10 @@ -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.
-

->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.
-

aes128-encryptor

Default 128bit AES encryptor with multi-round SHA-512 key-gen.
+

*default-freeze-compressor-selector*

dynamic

(fn selector [^bytes ba])->compressor used by `(freeze <x> {:compressor :auto}).
+

*final-freeze-fallback*

dynamic

->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.
+

aes128-encryptor

Default 128bit AES encryptor with multi-round SHA-512 key-gen.
 
 Password form [:salted "my-password"]
 ---------------------------------------
@@ -38,37 +37,36 @@ 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.

default-freeze-compressor-selector

(default-freeze-compressor-selector ba)
Strategy:
+increased danger if a key is somehow compromised.

byte-sized?

(byte-sized? n)

compress

(compress compressor ba)

decompress

(decompress compressor ba)

decrypt

(decrypt encryptor pwd ba)

default-freeze-compressor-selector

(default-freeze-compressor-selector ba)
Strategy:
 * Prioritize speed, but allow lz4.
 * Skip lz4 unless it's likely that lz4's space benefit will outweigh its
-  space overhead.

extend-freeze

macro

(extend-freeze type custom-type-id [x out] & body)
Extends Nippy to support freezing of a custom type (ideally concrete) with
+  space overhead.

encrypt

(encrypt encryptor pwd ba)

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.
-  * Byte ∈[1, 128] - no overhead, subject to id collisions.
+  * Keyword           - 2 byte overhead, resistent to id collisions
+  * Integer ∈[1, 128] - no overhead, subject to id collisions
 
 (defrecord MyType [data])
 (extend-freeze MyType :foo/my-type [x data-output] ; Keyword id
   (.writeUTF [data-output] (:data x)))
 ;; or
 (extend-freeze MyType 1 [x data-output] ; Byte id
-  (.writeUTF [data-output] (:data x)))

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)))

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)))
 ;; or
 (extend-thaw 1 [data-input] ; Byte id
-  (->MyType (.readUTF data-input)))

Freezable

protocol

Be careful about extending to interfaces, Ref. http://goo.gl/6gGRlU.
-

members

freeze-to-out*

(freeze-to-out* this out)

freezable?

(freezable? x & [{:keys [allow-clojure-reader? allow-java-serializable?]}])
Alpha - subject to change, MAY BE BUGGY!
+  (->MyType (.readUTF data-input)))

Freezable

protocol

Implementation detail. Be careful about extending to interfaces,
+Ref. http://goo.gl/6gGRlU.

members

-freeze-to-out

(-freeze-to-out this out)

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).

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.
-

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:
+pre/post serialization equality (there's no good general way of doing so).

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`.

freeze-fallback-as-str

(freeze-fallback-as-str out x)

freeze-to-out!

(freeze-to-out! data-output x)
Serializes arg (any Clojure data type) to a DataOutput
+

id-bigdec

id-bigint

id-biginteger

id-boolean

id-byte-as-long

id-bytes

id-double

id-float

id-int-as-long

id-integer

id-keyword

id-keyword-depr1

id-map-depr1

id-map-depr2

id-prefixed-custom

id-queue

id-ratio

id-reader

id-reader-depr1

id-record

id-reserved

id-serializable

id-short

id-short-as-long

id-sm-bytes

id-sm-keyword

id-sm-map

id-sm-set

id-sm-string

id-sm-vec

id-sorted-map

id-sorted-map-depr1

id-sorted-set

id-string

id-string-depr1

inspect-ba

(inspect-ba ba)(inspect-ba ba thaw-opts)
Alpha - subject to change
+

lz4-compressor

Default net.jpountz.lz4 compressor:
       Ratio: low.
 Write speed: very high.
  Read speed: very high.
@@ -76,30 +74,33 @@ 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

lz4hc-compressor

Like `lz4-compressor` but trades some write speed for ratio.
-

lzma2-compressor

Default org.tukaani.xz.LZMA2 compressor:
+Ref. https://github.com/mpenet/nippy-lz4

lz4hc-compressor

Like `lz4-compressor` but trades some write speed for ratio.
+

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.

map->Compressable-LZMA2

(map->Compressable-LZMA2 m__6289__auto__)
Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
-

map->StressRecord

(map->StressRecord m__6289__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)

read-utf8

macro

(read-utf8 in & [small?])

set-default-freeze-compressor-selector!

(set-default-freeze-compressor-selector! selector)
Sets root binding of `*default-freeze-compressor-selector*`.
-

snappy-compressor

Default org.iq80.snappy.Snappy compressor:
+environments.

map->Compressable-LZMA2

(map->Compressable-LZMA2 m__6289__auto__)
Factory function for class taoensso.nippy.Compressable-LZMA2, taking a map of keywords to field values.
+

map->StressRecord

(map->StressRecord m__6289__auto__)
Factory function for class taoensso.nippy.StressRecord, taking a map of keywords to field values.
+

read-biginteger

(read-biginteger in)

read-bytes

(read-bytes in)

read-coll

(read-coll in to-coll)

read-kvs

(read-kvs in to-coll)

read-kvs-depr1

(read-kvs-depr1 in to-coll)

read-sm-bytes

(read-sm-bytes in)

read-sm-coll

(read-sm-coll in to-coll)

read-sm-kvs

(read-sm-kvs in to-coll)

read-sm-utf8

(read-sm-utf8 in)

read-utf8

(read-utf8 in)

set-default-freeze-compressor-selector!

(set-default-freeze-compressor-selector! selector)
Sets root binding of `*default-freeze-compressor-selector*`
+

short-sized?

(short-sized? n)

snappy-compressor

Default org.iq80.snappy.Snappy compressor:
       Ratio: low.
 Write speed: very high.
  Read 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)(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`.
+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)(thaw ba {:keys [v1-compatibility? compressor encryptor password], :or {compressor :auto, encryptor :auto}, :as opts})
Deserializes a frozen object from given 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 **
+Add `{:v1-compatibility? true}` option to support thawing of data frozen with
+legacy versions of Nippy.
 
 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.

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 + :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

thaw-from-in!

(thaw-from-in! data-input)
Deserializes a frozen object from given DataInput to its original Clojure
+data type

when-debug

macro

(when-debug & body)

write-biginteger

(write-biginteger out n)

write-bytes

(write-bytes out ba)

write-id

macro

(write-id out id)

write-ided-bytes

(write-ided-bytes out ba)(write-ided-bytes out id-sm id ba)

write-ided-coll

(write-ided-coll out ?id-sm id coll)

write-ided-keyword

(write-ided-keyword out kw)

write-ided-kvs

(write-ided-kvs out ?id-sm id coll)

write-ided-long

(write-ided-long out n)

write-ided-map

(write-ided-map out m)

write-ided-set

(write-ided-set out s)

write-ided-string

(write-ided-string out s)

write-ided-vec

(write-ided-vec out v)

write-sm-bytes

(write-sm-bytes out ba)

write-sm-utf8

(write-sm-utf8 out s)

write-utf8

(write-utf8 out s)
\ No newline at end of file diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html index 7622323..9c804b2 100644 --- a/taoensso.nippy.tools.html +++ b/taoensso.nippy.tools.html @@ -1,9 +1,9 @@ -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.
-

thaw

(thaw ba & [{:keys [default-opts]}])
Like `nippy/thaw` but takes options from *thaw-opts* binding.
-

with-thaw-opts

macro

(with-thaw-opts opts & body)
Evaluates body using given options for any automatic deserialization in
-context.

wrap-for-freezing

(wrap-for-freezing value & [opts])
Wraps arg (any freezable data type) so that (tools/freeze <wrapped-arg>)
-will serialize the arg using given options.

wrapped-for-freezing?

(wrapped-for-freezing? x)
\ No newline at end of file +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.
+

thaw

(thaw ba & [{:keys [default-opts]}])
Like `nippy/thaw` but takes options from *thaw-opts* binding.
+

with-thaw-opts

macro

(with-thaw-opts opts & body)
Evaluates body using given options for any automatic deserialization in
+context.

wrap-for-freezing

(wrap-for-freezing value & [opts])
Wraps arg (any freezable data type) so that (tools/freeze <wrapped-arg>)
+will serialize the arg using given options.

wrapped-for-freezing?

(wrapped-for-freezing? x)
\ No newline at end of file diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html index fdf631a..ccd00fc 100644 --- a/taoensso.nippy.utils.html +++ b/taoensso.nippy.utils.html @@ -1,9 +1,9 @@ -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.
 
 `: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).

readable?

serializable?

\ No newline at end of file +pre/post serialization equality (there's no good general way of doing so).

readable?

serializable?

\ No newline at end of file