diff --git a/index.html b/index.html index 5a63b31..2f7290c 100644 --- a/index.html +++ b/index.html @@ -1,3 +1,5 @@ -Nippy 1.2.0 API documentation

Nippy 1.2.0 API documentation

Clojure serialization library

taoensso.nippy

Simple, high-performance Clojure serialization library. Adapted from
-Deep-Freeze.

taoensso.nippy.benchmarks

Public variables and functions:

    taoensso.nippy.utils

    Public variables and functions:

    \ No newline at end of file +Nippy 1.3.0-alpha2 API documentation

    Nippy 1.3.0-alpha2 API documentation

    Clojure serialization library

    taoensso.nippy

    Simple, high-performance Clojure serialization library. Adapted from
    +Deep-Freeze.

    taoensso.nippy.benchmarks

    Public variables and functions:

      taoensso.nippy.crypto

      Alpha - subject to change.
      +Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
      +deserves some privacy.

      Public variables and functions:

      taoensso.nippy.utils

      \ No newline at end of file diff --git a/taoensso.nippy.benchmarks.html b/taoensso.nippy.benchmarks.html index f811dc9..d019cf9 100644 --- a/taoensso.nippy.benchmarks.html +++ b/taoensso.nippy.benchmarks.html @@ -1,2 +1,2 @@ -taoensso.nippy.benchmarks documentation

      taoensso.nippy.benchmarks documentation

      \ No newline at end of file +taoensso.nippy.benchmarks documentation

      taoensso.nippy.benchmarks documentation

      \ No newline at end of file diff --git a/taoensso.nippy.crypto.html b/taoensso.nippy.crypto.html new file mode 100644 index 0000000..a6eb284 --- /dev/null +++ b/taoensso.nippy.crypto.html @@ -0,0 +1,28 @@ + +taoensso.nippy.crypto documentation

      taoensso.nippy.crypto documentation

      Alpha - subject to change.
      +Simple no-nonsense crypto with reasonable defaults. Because your Clojure data
      +deserves some privacy.

      aes128-cached

      USE CASE: You want only a small, finite number of passwords (e.g. a limited
      +           number of staff/admins, or you'll be using a single password to
      +           encrypt many items).
      +
      +IMPLEMENTATION: Uses a _very_ expensive (but cached) key hash, and no salt.
      +
      +PROS: Great amortized encryption/decryption speed. Expensive key hash makes
      +      attacking any particular key very difficult.
      +CONS: Using a small number of keys for many encrypted items means that if any
      +      key _is_ somehow compromised, _all_ items encrypted with that key are
      +      compromised.
      +
      +Faster than `aes128-salted`, and harder to attack any particular key - but
      +increased danger if a key is somehow compromised.

      aes128-salted

      USE CASE: You want more than a small, finite number of passwords (e.g. each
      +           item encrypted will use a unique user-provided password).
      +
      +IMPLEMENTATION: Uses a relatively cheap key hash, but automatically salts
      +                every key.
      +
      +PROS: Each key is independent so would need to be attacked independently.
      +CONS: Key caching impossible, so there's an inherent trade-off between
      +      encryption/decryption speed and the difficulty of attacking any
      +      particular key.
      +
      +Slower than `aes128-cached`, and easier to attack any particular key.
      \ No newline at end of file diff --git a/taoensso.nippy.html b/taoensso.nippy.html index 63dd9a4..777f609 100644 --- a/taoensso.nippy.html +++ b/taoensso.nippy.html @@ -1,13 +1,13 @@ -taoensso.nippy documentation

      taoensso.nippy documentation

      Simple, high-performance Clojure serialization library. Adapted from
      +taoensso.nippy documentation

      taoensso.nippy documentation

      Simple, high-performance Clojure serialization library. Adapted from
       Deep-Freeze.

      coll-freezer

      macro

      (coll-freezer type id & body)
      Extends Freezable to simple collection types.
       

      coll-thaw!

      (coll-thaw! s)
      Thaws simple collection types.
       

      coll-thaw-kvs!

      (coll-thaw-kvs! s)
      Thaws key-value collection types.
      -

      freeze-to-bytes

      (freeze-to-bytes x & {:keys [compress? print-dup?], :or {compress? true, print-dup? true}})
      Serializes x to a byte array and returns the array.
      +

      freeze-to-bytes

      (freeze-to-bytes x & {:keys [compress? print-dup? password], :or {compress? true, print-dup? true}})
      Serializes x to a byte array and returns the array.
       

      freeze-to-stream!

      (freeze-to-stream! data-output-stream x)(freeze-to-stream! data-output-stream x print-dup?)
      Serializes x to given output stream.
       

      freezer

      macro

      (freezer type id & body)
      Helper to extend Freezable protocol.
       

      kv-freezer

      macro

      (kv-freezer type id & body)
      Extends Freezable to key-value collection types.
       

      stress-data

      Reference data used for tests & benchmarks.
      -

      thaw-from-bytes

      (thaw-from-bytes ba & {:keys [read-eval? compressed?], :or {read-eval? false, compressed? true}})
      Deserializes an object from given byte array.
      +

      thaw-from-bytes

      (thaw-from-bytes ba & {:keys [compressed? read-eval? password], :or {compressed? true, read-eval? false}})
      Deserializes an object from given byte array.
       

      thaw-from-stream!

      (thaw-from-stream! data-input-stream read-eval?)
      Deserializes an object from given input stream.
       
      \ No newline at end of file diff --git a/taoensso.nippy.utils.html b/taoensso.nippy.utils.html index fab4bbb..65af72a 100644 --- a/taoensso.nippy.utils.html +++ b/taoensso.nippy.utils.html @@ -1,7 +1,8 @@ -taoensso.nippy.utils documentation

      taoensso.nippy.utils documentation

      bench

      macro

      (bench num-laps form & {:keys [warmup-laps num-threads as-ms?], :or {as-ms? true}})
      Repeatedly executes form and returns time taken to complete execution.
      +taoensso.nippy.utils documentation

      taoensso.nippy.utils documentation

      bench

      macro

      (bench num-laps form & {:keys [warmup-laps num-threads as-ms?], :or {as-ms? true}})
      Repeatedly executes form and returns time taken to complete execution.
       

      case-eval

      macro

      (case-eval e & clauses)
      Like `case` but evaluates test constants for their compile-time value.
      -

      pairs

      (pairs coll)
      Like (partition 2 coll) but faster and returns lazy seq of vector pairs.
      +

      memoized

      (memoized cache f & args)
      Like `memoize` but takes an explicit cache atom (possibly nil) and
      +immediately applies memoized f to given arguments.

      pairs

      (pairs coll)
      Like (partition 2 coll) but faster and returns lazy seq of vector pairs.
       

      time-ns

      macro

      (time-ns & body)
      Returns number of nanoseconds it takes to execute body.
       

      version-compare

      (version-compare x y)
      Comparator for version strings like x.y.z, etc.
       
      \ No newline at end of file