diff options
author | W. Felix Handte <w@felixhandte.com> | 2018-03-21 15:39:41 (GMT) |
---|---|---|
committer | W. Felix Handte <w@felixhandte.com> | 2018-03-21 15:39:41 (GMT) |
commit | a3a9b80dffc4d2c8e2496b851f78b78f0948c4bf (patch) | |
tree | 3bc8820d277d7ea73b862f38e82510a3b8275aff /lib/lz4.h | |
parent | 59cf6d400411b8373c0f52bffa180fe8fecff8e6 (diff) | |
download | lz4-a3a9b80dffc4d2c8e2496b851f78b78f0948c4bf.zip lz4-a3a9b80dffc4d2c8e2496b851f78b78f0948c4bf.tar.gz lz4-a3a9b80dffc4d2c8e2496b851f78b78f0948c4bf.tar.bz2 |
Better Describe Functionality of Obsolete Streaming Functions
Diffstat (limited to 'lib/lz4.h')
-rw-r--r-- | lib/lz4.h | 16 |
1 files changed, 10 insertions, 6 deletions
@@ -492,15 +492,19 @@ LZ4_DEPRECATED("use LZ4_compress_fast_continue() instead") LZ4LIB_API int LZ4_co LZ4_DEPRECATED("use LZ4_decompress_fast() instead") LZ4LIB_API int LZ4_uncompress (const char* source, char* dest, int outputSize); LZ4_DEPRECATED("use LZ4_decompress_safe() instead") LZ4LIB_API int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize); -/* Broken, obsolete streaming functions; do not use! +/* Obsolete streaming functions; degraded functionality; do not use! * - * These functions depended on data that is no longer tracked in the state. They - * are therefore broken--they don't retain any history across compressions. + * In order to perform streaming compression, these functions depended on data + * that is no longer tracked in the state. They have been preserved as well as + * possible: using them will still produce a correct output. However, they don't + * actually retain any history between compression calls. The compression ratio + * achieved will therefore be no better than compressing each chunk + * independently. */ -LZ4_DEPRECATED("Broken!!! Use LZ4_createStream() instead") LZ4LIB_API void* LZ4_create (char* inputBuffer); +LZ4_DEPRECATED("Use LZ4_createStream() instead") LZ4LIB_API void* LZ4_create (char* inputBuffer); LZ4_DEPRECATED("Use LZ4_createStream() instead") LZ4LIB_API int LZ4_sizeofStreamState(void); -LZ4_DEPRECATED("Broken!!! Use LZ4_resetStream() instead") LZ4LIB_API int LZ4_resetStreamState(void* state, char* inputBuffer); -LZ4_DEPRECATED("Broken!!! Use LZ4_saveDict() instead") LZ4LIB_API char* LZ4_slideInputBuffer (void* state); +LZ4_DEPRECATED("Use LZ4_resetStream() instead") LZ4LIB_API int LZ4_resetStreamState(void* state, char* inputBuffer); +LZ4_DEPRECATED("Use LZ4_saveDict() instead") LZ4LIB_API char* LZ4_slideInputBuffer (void* state); /* Obsolete streaming decoding functions */ LZ4_DEPRECATED("use LZ4_decompress_safe_usingDict() instead") LZ4LIB_API int LZ4_decompress_safe_withPrefix64k (const char* src, char* dst, int compressedSize, int maxDstSize); |