Commit e6bb4125 authored by Nils Goroll's avatar Nils Goroll

vmodtool-generated docs update

parent 11a3def3
...@@ -21,31 +21,28 @@ digests, checksums and hmacs for the VCL blob type ...@@ -21,31 +21,28 @@ digests, checksums and hmacs for the VCL blob type
SYNOPSIS SYNOPSIS
======== ========
.. parsed-literal::
:: import blobdigest [from "path"]
import blobdigest [from "path"] ;
new xdigest = blobdigest.digest(ENUM hash, BLOB init, ENUM scope)
BOOL xdigest.update(BLOB) new xdigest = blobdigest.digest(ENUM hash, BLOB init, ENUM scope)
BOOL xdigest.update(BLOB)
BLOB xdigest.final() BLOB xdigest.final()
BLOB hash(ENUM hash, BLOB msg)
BLOB hash(ENUM hash, BLOB msg) new xhmac = blobdigest.hmac(ENUM hash, BLOB key)
new xhmac = blobdigest.hmac(ENUM hash, BLOB key)
BLOB xhmac.hmac(BLOB msg) BLOB xhmac.hmac(BLOB msg)
DURATION xhmac.hmac_bench(INT n, BLOB msg) DURATION xhmac.hmac_bench(INT n, BLOB msg)
BLOB hmacf(ENUM hash, BLOB key, BLOB msg)
BLOB hmacf(ENUM hash, BLOB key, BLOB msg) STRING version()
STRING version()
:: ::
new OBJECT = blobdigest.digest(ENUM hash [, BLOB init], ["TASK"|"TOP"]) new OBJECT = blobdigest.digest(ENUM hash [, BLOB init], ["TASK"|"TOP"])
...@@ -224,11 +221,10 @@ values: ...@@ -224,11 +221,10 @@ values:
* ``SHA3_384`` * ``SHA3_384``
* ``SHA3_512`` * ``SHA3_512``
.. _obj_digest: .. _obj_digest:
digest(...) new xdigest = blobdigest.digest(ENUM hash, BLOB init, ENUM scope)
----------- -----------------------------------------------------------------
:: ::
...@@ -324,7 +320,6 @@ Example:: ...@@ -324,7 +320,6 @@ Example::
call do_backend_error; call do_backend_error;
} }
.. _func_digest.final: .. _func_digest.final:
BLOB xdigest.final() BLOB xdigest.final()
...@@ -409,10 +404,6 @@ Example:: ...@@ -409,10 +404,6 @@ Example::
# Baz-Hash-Base64: base64-encoded SHA3_256 hash of "baz" # Baz-Hash-Base64: base64-encoded SHA3_256 hash of "baz"
# Baz-Hash-Hex: hex-encoded SHA3_256 hash of "bar" # Baz-Hash-Hex: hex-encoded SHA3_256 hash of "bar"
.. _func_hash: .. _func_hash:
BLOB hash(ENUM hash, BLOB msg) BLOB hash(ENUM hash, BLOB msg)
...@@ -439,7 +430,6 @@ Example:: ...@@ -439,7 +430,6 @@ Example::
blobdigest.hash(SHA256, blobdigest.hash(SHA256,
blob.decode(decoding=BASE64, encoded="Zm9v")); blob.decode(decoding=BASE64, encoded="Zm9v"));
.. _obj_hmac: .. _obj_hmac:
new xhmac = blobdigest.hmac(ENUM hash, BLOB key) new xhmac = blobdigest.hmac(ENUM hash, BLOB key)
...@@ -489,7 +479,6 @@ Example:: ...@@ -489,7 +479,6 @@ Example::
return(synth(401)); return(synth(401));
} }
.. _func_hmac.hmac_bench: .. _func_hmac.hmac_bench:
DURATION xhmac.hmac_bench(INT n, BLOB msg) DURATION xhmac.hmac_bench(INT n, BLOB msg)
...@@ -497,10 +486,6 @@ DURATION xhmac.hmac_bench(INT n, BLOB msg) ...@@ -497,10 +486,6 @@ DURATION xhmac.hmac_bench(INT n, BLOB msg)
Run `n` rounds of ``.hmac`` and return the net total duration. Run `n` rounds of ``.hmac`` and return the net total duration.
.. _func_hmacf: .. _func_hmacf:
BLOB hmacf(ENUM hash, BLOB key, BLOB msg) BLOB hmacf(ENUM hash, BLOB key, BLOB msg)
...@@ -540,7 +525,6 @@ Example:: ...@@ -540,7 +525,6 @@ Example::
blob.decode(encoded= blob.decode(encoded=
req.http.Msg))); req.http.Msg)));
.. _func_version: .. _func_version:
STRING version() STRING version()
...@@ -607,7 +591,6 @@ SEE ALSO ...@@ -607,7 +591,6 @@ SEE ALSO
* https://github.com/rhash/RHash * https://github.com/rhash/RHash
* http://rhash.anz.ru/ * http://rhash.anz.ru/
COPYRIGHT COPYRIGHT
========= =========
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment