diff options
| author | June McEnroe <june@causal.agency> | 2018-11-11 15:21:29 -0500 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2018-11-11 15:21:29 -0500 |
| commit | 6cb1c9b40125400666a1f95c05d0f82544977af8 (patch) | |
| tree | a35ab34ecb27eaf2444f0dc842428a96054a97a5 /deflateBound.3 | |
| parent | Add deflateTune.3 (diff) | |
| download | zlib-man-pages-6cb1c9b40125400666a1f95c05d0f82544977af8.tar.gz zlib-man-pages-6cb1c9b40125400666a1f95c05d0f82544977af8.zip | |
Add deflateBound.3
Diffstat (limited to '')
| -rw-r--r-- | deflateBound.3 | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/deflateBound.3 b/deflateBound.3 new file mode 100644 index 0000000..d8f91d5 --- /dev/null +++ b/deflateBound.3 @@ -0,0 +1,57 @@ +.Dd November 11, 2018 +.Dt DEFLATEBOUND 3 +.Os +. +.Sh NAME +.Nm deflateBound +.Nd compressed size upper bound +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.Ft uLong +.Fn deflateBound "z_streamp strm" "uLong sourceLen" +. +.Sh DESCRIPTION +.Fn deflateBound +returns an upper bound +on the compressed size +after deflation of +.Fa sourceLen +bytes. +It must be called after +.Xr deflateInit 3 +or +.Xr deflateInit2 3 , +and after +.Xr deflateSetHeader 3 , +if used. +This would be used +to allocate an output buffer +for deflation in a single pass, +and so would be called before +.Xr deflate 3 . +If that first +.Fn deflate +call is provided the +.Fa sourceLen +input bytes, +an output buffer allocated +to the size returned by +.Fn deflateBound , +and the flush value +.Dv Z_FINISH , +then +.Fn deflate +is guaranteed to return +.Dv Z_STREAM_END . +Note that it is possible +for the compressed size +to be larger than the value returned by +.Fn deflateBound +if flush options other than +.Dv Z_FINISH +or +.Dv Z_NO_FLUSH +are used. |