diff options
| author | Jack Lloyd <[email protected]> | 2017-11-14 20:58:18 -0500 |
|---|---|---|
| committer | Jack Lloyd <[email protected]> | 2017-11-14 20:58:18 -0500 |
| commit | 122ceb41f0366a48e84eac3e69e940db2a00eb28 (patch) | |
| tree | 4a75edb73356b723a192e75b0daca20ceb75893b /doc/manual/compression.rst | |
| parent | f66fd9c12ff7d64c925e73be12a27135790994c3 (diff) | |
Update manual to avoid use of old integer typedefs.
Diffstat (limited to 'doc/manual/compression.rst')
| -rw-r--r-- | doc/manual/compression.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/manual/compression.rst b/doc/manual/compression.rst index 2d1f4c142..4a40b24c7 100644 --- a/doc/manual/compression.rst +++ b/doc/manual/compression.rst @@ -29,7 +29,7 @@ finally completing processing the stream (``finish``). CPU time consumed by the compression process. The decompressor can always handle input from any compressor. - .. cpp:function:: void update(secure_vector<byte>& buf, \ + .. cpp:function:: void update(secure_vector<uint8_t>& buf, \ size_t offset = 0, bool flush = false) Compress the material in the in/out parameter ``buf``. The leading @@ -39,7 +39,7 @@ finally completing processing the stream (``finish``). entire message up to this point without having the see the rest of the compressed stream. - .. cpp::function:: void finish(secure_vector<byte>& buf, size_t offset = 0) + .. cpp::function:: void finish(secure_vector<uint8_t>& buf, size_t offset = 0) Finish compressing a message. The ``buf`` and ``offset`` parameters are treated as in ``update``. It is acceptable to call ``start`` followed by @@ -54,7 +54,7 @@ finally completing processing the stream (``finish``). ``update`` or ``finish``. No level is provided here; the decompressor can accept input generated by any compression parameters. - .. cpp:function:: void update(secure_vector<byte>& buf, \ + .. cpp:function:: void update(secure_vector<uint8_t>& buf, \ size_t offset = 0) Decompress the material in the in/out parameter ``buf``. The leading @@ -63,7 +63,7 @@ finally completing processing the stream (``finish``). This function may throw if the data seems to be invalid. - .. cpp::function:: void finish(secure_vector<byte>& buf, size_t offset = 0) + .. cpp::function:: void finish(secure_vector<uint8_t>& buf, size_t offset = 0) Finish decompressing a message. The ``buf`` and ``offset`` parameters are treated as in ``update``. It is acceptable to call ``start`` followed by |