diff options
author | Yann Collet <cyan@fb.com> | 2020-11-07 04:46:35 (GMT) |
---|---|---|
committer | Yann Collet <cyan@fb.com> | 2020-11-07 04:46:35 (GMT) |
commit | 27959b43ec4d4afe1e9d7654258eacf5e29ecf2b (patch) | |
tree | 116cdd5f2cd9e9a40123d838271bbbd351b03e1d /lib/lz4frame.h | |
parent | b5e2a4acd953fd21fef2c372d9750992d454e76f (diff) | |
download | lz4-27959b43ec4d4afe1e9d7654258eacf5e29ecf2b.zip lz4-27959b43ec4d4afe1e9d7654258eacf5e29ecf2b.tar.gz lz4-27959b43ec4d4afe1e9d7654258eacf5e29ecf2b.tar.bz2 |
LZ4F_decompress requires a valid dctx state
This is now explicitly documented and asserted.
fix #927
Diffstat (limited to 'lib/lz4frame.h')
-rw-r--r-- | lib/lz4frame.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h index c669aec..6e91e2d 100644 --- a/lib/lz4frame.h +++ b/lib/lz4frame.h @@ -431,8 +431,10 @@ LZ4FLIB_API size_t LZ4F_getFrameInfo(LZ4F_dctx* dctx, const void* srcBuffer, size_t* srcSizePtr); /*! LZ4F_decompress() : - * Call this function repetitively to regenerate compressed data from `srcBuffer`. - * The function will read up to *srcSizePtr bytes from srcBuffer, + * Call this function repetitively to regenerate data compressed in `srcBuffer`. + * + * The function requires a valid dctx state. + * It will read up to *srcSizePtr bytes from srcBuffer, * and decompress data into dstBuffer, of capacity *dstSizePtr. * * The nb of bytes consumed from srcBuffer will be written into *srcSizePtr (necessarily <= original value). |