diff --git a/css/default.css b/css/default.css index 932f18c..c6434e9 100644 --- a/css/default.css +++ b/css/default.css @@ -65,7 +65,7 @@ h2 { .sidebar.secondary { background: #f2f2f2; - border-right: solid 1px #cccccc; + border-right: solid 1px #d7d7d7; left: 251px; width: 200px; } @@ -101,7 +101,7 @@ h2 { } .project-version { - padding-left: 5px; + padding-left: 0.15em; } #header a, .sidebar a { @@ -419,10 +419,6 @@ p { margin-bottom: 10px; } -.markdown { - font-size: 14px; -} - .markdown p, .markdown li, .markdown dt, .markdown dd, .markdown td { line-height: 18px; } @@ -451,7 +447,7 @@ p { border-radius: 2px; } -.markdown pre { +.markdown pre, pre.deps { background: #f4f4f4; border: 1px solid #e0e0e0; border-radius: 2px; @@ -459,11 +455,21 @@ p { margin: 0 10px; } +pre.deps { + display: inline-block; +} + .markdown pre code { background: transparent; border: none; } +.markdown hr { + border-style: solid; + border-top: none; + color: #ccc; +} + .doc ul, .doc ol { padding-left: 30px; } diff --git a/index.html b/index.html index 01fbaad..0316b39 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,4 @@ -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.benchmarks

Public variables and functions:

taoensso.nippy.compression

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 2.11.0-RC1

Nippy 2.11.0-RC1

High-performance serialization library for Clojure

Installation

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

[com.taoensso/nippy "2.11.0-RC1"]

Namespaces

taoensso.nippy

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

taoensso.nippy.encryption

Simple no-nonsense crypto with reasonable defaults.

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/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index 7d4d7c6..9949b7f 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])

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 d26698a..8938cca 100644 --- a/taoensso.nippy.compression.html +++ b/taoensso.nippy.compression.html @@ -1,5 +1,5 @@ -taoensso.nippy.compression documentation

taoensso.nippy.compression

->LZ4Compressor

(->LZ4Compressor compressor decompressor)
Positional factory function for class taoensso.nippy.compression.LZ4Compressor.
+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:
diff --git a/taoensso.nippy.encryption.html b/taoensso.nippy.encryption.html
index 78ca9c6..5aa2510 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
-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.
+taoensso.nippy.encryption documentation

taoensso.nippy.encryption

Simple no-nonsense crypto with reasonable defaults.
+

->AES128Encryptor

(->AES128Encryptor key-gen key-cache)
Positional factory function for class taoensso.nippy.encryption.AES128Encryptor.
+

aes128-encryptor

Default 128bit AES encryptor with many-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__6518__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 213a8da..f91b08c 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,10 +1,10 @@ -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])}
+taoensso.nippy documentation

taoensso.nippy

High-performance serialization library for Clojure.
+Originally adapted from Deep-Freeze (Ref. 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

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

aes128-encryptor

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

map->Compressable-LZMA2

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

map->StressRecord

(map->StressRecord m__6518__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.
diff --git a/taoensso.nippy.tools.html b/taoensso.nippy.tools.html
index 9c804b2..7ece738 100644
--- a/taoensso.nippy.tools.html
+++ b/taoensso.nippy.tools.html
@@ -1,8 +1,8 @@
 
-taoensso.nippy.tools documentation

taoensso.nippy.tools

Utilities for third-party tools that want to add fully-user-configurable
+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.
+present.

map->WrappedForFreezing

(map->WrappedForFreezing m__6518__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>)
diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html
index ccd00fc..f0d3ed7 100644
--- a/taoensso.nippy.utils.html
+++ b/taoensso.nippy.utils.html
@@ -1,5 +1,5 @@
 
-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.