diff options
author | Yann Collet <Cyan4973@users.noreply.github.com> | 2017-04-11 21:43:11 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-04-11 21:43:11 (GMT) |
commit | 31e9ed612bfafade0a8589fb71b6f1f43bd439c2 (patch) | |
tree | c713ab373bca1e02a55036432a90fe8782e31197 /lib/lz4.h | |
parent | e2827775ee80d2ef985858727575df31fc60f1f3 (diff) | |
parent | e2c9b19122a19fa8a46a253e4ce556a5b75fa8b1 (diff) | |
download | lz4-31e9ed612bfafade0a8589fb71b6f1f43bd439c2.zip lz4-31e9ed612bfafade0a8589fb71b6f1f43bd439c2.tar.gz lz4-31e9ed612bfafade0a8589fb71b6f1f43bd439c2.tar.bz2 |
Merge pull request #347 from lz4/negativeCLevels
Negative Compression levels
Diffstat (limited to 'lib/lz4.h')
-rw-r--r-- | lib/lz4.h | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -256,19 +256,19 @@ LZ4LIB_API int LZ4_loadDict (LZ4_stream_t* streamPtr, const char* dictionary, in /*! LZ4_compress_fast_continue() : * Compress buffer content 'src', using data from previously compressed blocks as dictionary to improve compression ratio. - * Important : Previous data blocks are assumed to still be present and unmodified ! + * Important : Previous data blocks are assumed to remain present and unmodified ! * 'dst' buffer must be already allocated. - * If maxDstSize >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster. + * If dstCapacity >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster. * If not, and if compressed data cannot fit into 'dst' buffer size, compression stops, and function returns a zero. + * After an error, the stream status is invalid, and it can only be reset or freed. */ -LZ4LIB_API int LZ4_compress_fast_continue (LZ4_stream_t* streamPtr, const char* src, char* dst, int srcSize, int maxDstSize, int acceleration); +LZ4LIB_API int LZ4_compress_fast_continue (LZ4_stream_t* streamPtr, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); /*! LZ4_saveDict() : - * If previously compressed data block is not guaranteed to remain available at its memory location, + * If previously compressed data block is not guaranteed to remain available at its current memory location, * save it into a safer place (char* safeBuffer). - * Note : you don't need to call LZ4_loadDict() afterwards, - * dictionary is immediately usable, you can therefore call LZ4_compress_fast_continue(). - * Return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error. + * Note : it's not necessary to call LZ4_loadDict() after LZ4_saveDict(), dictionary is immediately usable. + * @return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error. */ LZ4LIB_API int LZ4_saveDict (LZ4_stream_t* streamPtr, char* safeBuffer, int dictSize); |