diff options
author | W. Felix Handte <w@felixhandte.com> | 2018-03-14 19:58:38 (GMT) |
---|---|---|
committer | W. Felix Handte <w@felixhandte.com> | 2018-03-14 19:59:33 (GMT) |
commit | b0a18896fe53cf2b69142c092f955e57b2b0d8df (patch) | |
tree | 35eb0fd01a73c34b59f14082afaf9ac833924d59 | |
parent | 66b6fbfe6fa9d7e8d4686e6525883ff4aef31e02 (diff) | |
download | lz4-b0a18896fe53cf2b69142c092f955e57b2b0d8df.zip lz4-b0a18896fe53cf2b69142c092f955e57b2b0d8df.tar.gz lz4-b0a18896fe53cf2b69142c092f955e57b2b0d8df.tar.bz2 |
Move LZ4_compress_fast_extState_noReset Declaration to Unstable Section
-rw-r--r-- | lib/lz4.h | 31 |
1 files changed, 23 insertions, 8 deletions
@@ -179,21 +179,13 @@ LZ4LIB_API int LZ4_compress_fast (const char* src, char* dst, int srcSize, int d /*! -LZ4_compress_fast_extState_noReset() : LZ4_compress_fast_extState() : Same compression function, just using an externally allocated memory space to store compression state. Use LZ4_sizeofState() to know how much memory must be allocated, and allocate it on 8-bytes boundaries (using malloc() typically). Then, provide it as 'void* state' to compression function. - - Use the _noReset variant if LZ4_resetStream() was called on the state - buffer before being used for the first time (calls to both extState - functions leave the state in a safe state, so zeroing is not required - between calls). Otherwise, using the legacy _extState requires LZ4 to - reinitialize the state internally for every call. */ LZ4LIB_API int LZ4_sizeofState(void); -LZ4LIB_API int LZ4_compress_fast_extState_noReset (void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); LZ4LIB_API int LZ4_compress_fast_extState (void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); @@ -351,6 +343,29 @@ LZ4LIB_API int LZ4_decompress_fast_usingDict (const char* src, char* dst, int or /*^********************************************** * !!!!!! STATIC LINKING ONLY !!!!!! ***********************************************/ + +/*-************************************ + * Unstable declarations + ************************************** + * Declarations in this section should be considered unstable. + * Use at your own peril, etc., etc. + * They may be removed in the future. + * Their signatures may change. + **************************************/ + +/*! +LZ4_compress_fast_extState_noReset() : + A variant of LZ4_compress_fast_extState(). + + Use the _noReset variant if LZ4_resetStream() was called on the state + buffer before being used for the first time (calls to both extState + functions leave the state in a safe state, so zeroing is not required + between calls). Otherwise, using the plain _extState requires LZ4 to + reinitialize the state internally for every call. +*/ +LZ4LIB_API int LZ4_compress_fast_extState_noReset (void* state, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); + + /*-************************************ * Private definitions ************************************** |