diff options
author | yann.collet.73@gmail.com <yann.collet.73@gmail.com@650e7d94-2a16-8b24-b05c-7c0b3f6821cd> | 2011-09-25 21:34:35 (GMT) |
---|---|---|
committer | yann.collet.73@gmail.com <yann.collet.73@gmail.com@650e7d94-2a16-8b24-b05c-7c0b3f6821cd> | 2011-09-25 21:34:35 (GMT) |
commit | 420248cff40ee04fef085c2029498a2423fce5cc (patch) | |
tree | fed1c510402e6bfaea361353e83baf5ee19b6a6c /lz4.h | |
parent | dab6b9d3dc9c1f6b6f30e23f44d5fc8fa445fd65 (diff) | |
download | lz4-420248cff40ee04fef085c2029498a2423fce5cc.zip lz4-420248cff40ee04fef085c2029498a2423fce5cc.tar.gz lz4-420248cff40ee04fef085c2029498a2423fce5cc.tar.bz2 |
CLI : added test mode
CLI : corrected writing to NULL within Linux
Minor : several comments were updated
git-svn-id: https://lz4.googlecode.com/svn/trunk@29 650e7d94-2a16-8b24-b05c-7c0b3f6821cd
Diffstat (limited to 'lz4.h')
-rw-r--r-- | lz4.h | 18 |
1 files changed, 4 insertions, 14 deletions
@@ -48,10 +48,10 @@ LZ4_compress : Worst case size is : "inputsize + 0.4%", with "0.4%" being at least 8 bytes.
LZ4_uncompress :
+ osize : is the output size, therefore the original size
return : the number of bytes read in the source buffer
If the source stream is malformed, the function will stop decoding and return a negative result, indicating the byte position of the faulty instruction
This version never writes beyond dest + osize, and is therefore protected against malicious data packets
- note 1 : osize is the output size, therefore the original size
note 2 : destination buffer must be already allocated
*/
@@ -64,12 +64,12 @@ int LZ4_uncompress_unknownOutputSize (char* source, char* dest, int isize, int m /*
LZ4_uncompress_unknownOutputSize :
+ isize : is the input size, therefore the compressed size
+ maxOutputSize : is the size of the destination buffer (which must be already allocated)
return : the number of bytes decoded in the destination buffer (necessarily <= maxOutputSize)
If the source stream is malformed, the function will stop decoding and return a negative result, indicating the byte position of the faulty instruction
This version never writes beyond dest + maxOutputSize, and is therefore protected against malicious data packets
- note 1 : isize is the input size, therefore the compressed size
- note 2 : destination buffer must already be allocated, with at least maxOutputSize bytes
- note 3 : this version is slower by up to 10%, and is therefore not recommended for general use
+ note : This version is slower than LZ4_uncompress, and is therefore not recommended for general use
*/
@@ -88,16 +88,6 @@ LZ4_compressCtx : */
-//*********************************
-// Deprecated decoding function
-//*********************************
-
-/*
-LZ4_decode : Starting with r12, LZ4_decode() is no longer provided in LZ4 source code.
- If you need to provide "isize" instead of "osize" to the decoder, please use LZ4_uncompress_unknownOutputSize(), which is safer.
-*/
-
-
#if defined (__cplusplus)
}
#endif
|