cuberite/libdeflate
1
0
Fork 0
mirror of https://github.com/cuberite/libdeflate.git synced 2025-09-08 11:50:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document that NULL may be passed to deflate_compress_bound()

Browse Source
This commit is contained in:
Eric Biggers 2016-02-01 21:55:51 -06:00
parent c1032c8dae
commit c1b6c31da7
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
libdeflate.h
View File

@ -65,6 +65,10 @@ deflate_compress(struct deflate_compressor *compressor,
* the true upper bound. The return value is guaranteed to be the same for all
* invocations with the same compressor and same 'in_nbytes'.
*
* As a special case, 'compressor' may be NULL. This causes the bound to be
* taken across *any* deflate_compressor that could ever be allocated with this
* build of the library, with any options.
*
* Note that this function is not necessary in many applications. With
* block-based compression, it is usually preferable to separately store the
* uncompressed size of each block and to store any blocks that did not compress