summaryrefslogtreecommitdiffstats
path: root/lib/lz4.h
diff options
context:
space:
mode:
authorYann Collet <yann.collet.73@gmail.com>2015-05-06 19:23:06 (GMT)
committerYann Collet <yann.collet.73@gmail.com>2015-05-06 19:23:06 (GMT)
commit672bfdebd0975289dbbdecabeeda9fabb499475a (patch)
tree79f6d5790b732eefde9a1ca2b448daf6dca449d5 /lib/lz4.h
parentb4ef93a83707614b66e3f44706d9992048119768 (diff)
downloadlz4-672bfdebd0975289dbbdecabeeda9fabb499475a.zip
lz4-672bfdebd0975289dbbdecabeeda9fabb499475a.tar.gz
lz4-672bfdebd0975289dbbdecabeeda9fabb499475a.tar.bz2
Updated comments
Diffstat (limited to 'lib/lz4.h')
-rw-r--r--lib/lz4.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/lz4.h b/lib/lz4.h
index 93388c2..20e3d48 100644
--- a/lib/lz4.h
+++ b/lib/lz4.h
@@ -89,10 +89,10 @@ LZ4_compress_default() :
or 0 if compression fails
LZ4_decompress_safe() :
- compressedSize : is obviously the source size
- maxDecompressedSize : is the size of the destination buffer, which must be already allocated.
- return : the number of bytes decompressed into the destination buffer (necessarily <= maxDecompressedSize)
- If the destination buffer is not large enough, decoding will stop and output an error code (<0).
+ compressedSize : is the precise full size of the compressed block.
+ maxDecompressedSize : is the size of destination buffer, which must be already allocated.
+ return : the number of bytes decompressed into destination buffer (necessarily <= maxDecompressedSize)
+ If destination buffer is not large enough, decoding will stop and output an error code (<0).
If the source stream is detected malformed, the function will stop decoding and return a negative result.
This function is protected against buffer overflow exploits, including malicious data packets.
It never writes outside output buffer, nor reads outside input buffer.