summaryrefslogtreecommitdiffstats
path: root/lib/lz4frame.h
diff options
context:
space:
mode:
authorAlexander Mohr <alexander.m.mohr@mercedes-benz.com>2022-06-10 06:37:57 (GMT)
committerAlexander Mohr <alexander.m.mohr@mercedes-benz.com>2022-06-10 06:37:57 (GMT)
commit5c7382798eb9b5af9eaa6c66f018c8efcb62f8d5 (patch)
tree76a0bfb048cd619191d5729e8dde6a41faa2de25 /lib/lz4frame.h
parent62f6cef564a9478b92e6dbd0faa81eaa1a90b34f (diff)
downloadlz4-5c7382798eb9b5af9eaa6c66f018c8efcb62f8d5.zip
lz4-5c7382798eb9b5af9eaa6c66f018c8efcb62f8d5.tar.gz
lz4-5c7382798eb9b5af9eaa6c66f018c8efcb62f8d5.tar.bz2
review: Fix review findings
This commit fixes the review findings Signed-off-by: Alexander Mohr <alexander.m.mohr@mercedes-benz.com>
Diffstat (limited to 'lib/lz4frame.h')
-rw-r--r--lib/lz4frame.h33
1 files changed, 17 insertions, 16 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h
index 20bfb8b..7d81fa0 100644
--- a/lib/lz4frame.h
+++ b/lib/lz4frame.h
@@ -314,22 +314,6 @@ LZ4FLIB_API size_t LZ4F_compressUpdate(LZ4F_cctx* cctx,
const void* srcBuffer, size_t srcSize,
const LZ4F_compressOptions_t* cOptPtr);
-/*! LZ4F_uncompressedUpdate() :
- * LZ4F_uncompressedUpdate() can be called repetitively to add as much data uncompressed data as necessary.
- * Important rule: dstCapacity MUST be large enough to store the entire source buffer as
- * no compression is done for this operation
- * If this condition is not respected, LZ4F_uncompressedUpdate() will fail (result is an errorCode).
- * After an error, the state is left in a UB state, and must be re-initialized or freed.
- * If previously a compressed block was written, buffered data is flushed
- * before appending uncompressed data is continued.
- * `cOptPtr` is optional : NULL can be provided, in which case all options are set to default.
- * @return : number of bytes written into `dstBuffer` (it can be zero, meaning input data was just buffered).
- * or an error code if it fails (which can be tested using LZ4F_isError())
- */
-LZ4FLIB_API size_t LZ4F_uncompressedUpdate(LZ4F_cctx* cctx,
- void* dstBuffer, size_t dstCapacity,
- const void* srcBuffer, size_t srcSize,
- const LZ4F_compressOptions_t* cOptPtr);
/*! LZ4F_flush() :
* When data must be generated and sent immediately, without waiting for a block to be completely filled,
* it's possible to call LZ4_flush(). It will immediately compress any data buffered within cctx.
@@ -560,6 +544,23 @@ LZ4FLIB_STATIC_API LZ4F_errorCodes LZ4F_getErrorCode(size_t functionResult);
LZ4FLIB_STATIC_API size_t LZ4F_getBlockSize(unsigned);
+/*! LZ4F_uncompressedUpdate() :
+ * LZ4F_uncompressedUpdate() can be called repetitively to add as much data uncompressed data as necessary.
+ * Important rule: dstCapacity MUST be large enough to store the entire source buffer as
+ * no compression is done for this operation
+ * If this condition is not respected, LZ4F_uncompressedUpdate() will fail (result is an errorCode).
+ * After an error, the state is left in a UB state, and must be re-initialized or freed.
+ * If previously a compressed block was written, buffered data is flushed
+ * before appending uncompressed data is continued.
+ * `cOptPtr` is optional : NULL can be provided, in which case all options are set to default.
+ * @return : number of bytes written into `dstBuffer` (it can be zero, meaning input data was just buffered).
+ * or an error code if it fails (which can be tested using LZ4F_isError())
+ */
+LZ4FLIB_STATIC_API size_t LZ4F_uncompressedUpdate(LZ4F_cctx* cctx,
+ void* dstBuffer, size_t dstCapacity,
+ const void* srcBuffer, size_t srcSize,
+ const LZ4F_compressOptions_t* cOptPtr);
+
/**********************************
* Bulk processing dictionary API
*********************************/