lib/zlib/zlib.h

65   with an interface similar to that of stdio using the functions that start
66   with "gz".  The gzip format is different from the zlib format.  gzip is a
159    the library with -DMAX_WBITS=14 (see zconf.h).
206 #define Z_ASCII    Z_TEXT   /* for compatibility with 1.2.2 and earlier */
216 /* for compatibility with versions < 1.0.2 */
224    compatible with the zlib.h header file used by the application.  This check
245    with the version assumed by the caller (ZLIB_VERSION).  msg is set to null
277   == 0), or after each call of deflate().  If deflate returns Z_OK and with
293   completes the current deflate block and follows it with an empty stored block
300   This completes the current deflate block and follows it with an empty fixed
314     If flush is set to Z_FULL_FLUSH, all output is flushed as with
320     If deflate returns with avail_out == 0, this function must be called again
321   with the same value of the flush parameter and more output space (updated
322   avail_out), until the flush is complete (deflate returns with non-zero
328   pending output is flushed and deflate returns with Z_STREAM_END if there was
329   enough output space.  If deflate returns with Z_OK or Z_BUF_ERROR, this
330   function must be called again with Z_FINISH and more output space (updated
331   avail_out) but no more input data, until it returns with Z_STREAM_END or an
359   deflate() can be called again with more input and more output space to
390    memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
429   inflate().  If inflate returns Z_OK and with zero avail_out, it must be
497   initializing with inflateInit2().  Any information contained in the gzip
508   value, in which case strm->msg points to a string with a more specific
514   inflate() can be called again with more input and more output space to
546      This is another version of deflateInit with more compression options.  The
561    inflateInit2() will result in an error when the zlib header with 9 is
563    with deflateInit2() with this initialization, or at least in that case use 9
564    with inflateInit2().
568    with no zlib header or trailer, and will not compute a check value.
592    encoding).  Filtered data consists mostly of small values with a somewhat
606    incompatible with the version assumed by the caller (ZLIB_VERSION).  msg is
627    to be encountered later in the data to be compressed, with the most commonly
630    predicted with good accuracy; the data can then be compressed better than
631    with the default empty dictionary.
662    always enough.  If deflateGetDictionary() is called with dictionary equal to
684    data with a filter.  The streams that will be discarded should then be freed
717    compressed with the old level and strategy using deflate(strm, Z_BLOCK).
724    take effect.  In this case, deflateParams() can be called again with the
728    deflate stream should be flushed using deflate() with Z_BLOCK or other flush
741    retried with more output space.
796    is that this function is used to start off the deflate output with the bits
817    caller must assure that, if not Z_NULL, name and comment are terminated with
825    the time set to zero, and os set to 255, with no extra, name, or comment
836      This is another version of inflateInit with an extra parameter.  The
845    deflateInit2() was not used.  If a compressed stream with a larger window
846    size is given as input, inflate() will return with the error code
856    is for use with other formats that use the deflate compressed data format
865    32 to windowBits to enable zlib and gzip decoding with automatic header
873    decompression to be compliant with the gzip standard (RFC 1952).
876    memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
917    always enough.  If inflateGetDictionary() is called with dictionary equal to
928    for the description of deflate with Z_FULL_FLUSH) can be found, or until all
991    from next_in.  This function should only be used with raw inflate, and
1012    the middle of a stored block, with the lower value equaling the number of
1046      The text, time, xflags, and os fields are filled in with the gzip header
1053    terminated with a zero unless the length is greater than name_max.  If
1055    terminated with a zero unless the length is greater than comm_max.  When any
1058    absence.  This allows the use of deflateSetHeader() with the returned
1083    assured that deflate was used with small window sizes, windowBits must be 15
1103      inflateBack() does a raw inflate with a single call using a call-back
1107    buffer.  inflate() can be faster on modern CPUs when used with large
1112    and to initialize the state with the user-provided window buffer.
1114    deflate stream with each call.  inflateBackEnd() is then called to free the
1117      A raw deflate stream is one with no zlib or gzip header or trailer.
1136    returns non-zero, inflateBack() will return with an error.  Neither in() nor
1206      21: FASTEST -- deflate algorithm with only one, lowest compression level
1237    compressed data.  compress() is equivalent to compress2() with a level
1283    buffer with the uncompressed data up to that point.
1297      This library supports reading and writing files in gzip (.gz) format with
1298    an interface similar to that of stdio, using the functions that start with
1315    appending with no compression and not using the gzip format.
1327    appending, gzopen does not test whether the file begins with a gzip stream,
1345      Associate a gzFile with the file descriptor fd.  File descriptors are
1347    been previously opened with fopen).  The mode parameter is as in gzopen.
1406    Upon reaching the end of the input, gzread will return with the available
1428    stdio's fread(), with size_t request and return types.  If the library
1459    the interface of stdio's fwrite(), with size_t request and return types.  If
1477    return an error (0) with nothing written.  In this case, there may also be a
1478    buffer overflow with unpredictable consequences, which is possible only if
1479    zlib was compiled with the insecure functions sprintf() or vsprintf(),
1497    is one, the string is terminated with a null character.  If no characters
1529    The pushed character will be discarded if the stream is repositioned with
1636    cannot call gzerror with file, since its structures have been deallocated.
1692      Update a running Adler-32 checksum with the bytes buf[0..len-1] and
1713      Same as adler32(), but with a size_t length.
1721    and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
1730      Update a running CRC-32 with the bytes buf[0..len-1] and return the
1749      Same as crc32(), but with a size_t length.
1756    seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
1765      Return the operator corresponding to length len2, to be used with
1831  * user should not mess with these exposed elements, since their names or