libkern/libkern/zlib.h

6  * This file contains Original Code and/or Modifications of Original Code
8  * Version 2.0 (the 'License'). You may not use this file except in
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
78   enough (for example if an input file is mmap'ed), or can be done by
96   file compression on file systems, has a larger header than zlib to maintain
139     int     xflags;     /* extra flags (not used when writing a gzip file) */
144     Bytef   *name;      /* pointer to zero-terminated file name or Z_NULL */
150                            when writing a gzip file) */
244    not compatible with the zlib.h header file used by the application.
536    file name, no extra data, no comment, no modification time (set to zero),
712    gzip file" and give up.
903    match the version of the header file.
915    file i/o applications in that it avoids copying between the output and the
1046      This function can be used to compress a whole file at once if the
1047    input file is mmap'ed.
1086      This function can be used to decompress a whole file at once if the
1087    input file is mmap'ed.
1100      Opens a gzip (.gz) file for reading or writing. The mode parameter
1107      gzopen can be used to read a file which is not in gzip format; in this
1108    case gzread will directly read from the file without decompression.
1110      gzopen returns NULL if the file could not be opened or if there was
1117      gzdopen() associates a gzFile with the file descriptor fd.  File
1119    fileno (in the file has been previously opened with fopen).
1122    file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
1128 ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
1132      gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
1136 ZEXTERN int ZEXPORT    gzread  OF((gzFile file, voidp buf, unsigned len));
1138      Reads the given number of uncompressed bytes from the compressed file.
1139    If the input file was not in gzip format, gzread copies the given number
1142    end of file, -1 for error). */
1144 ZEXTERN int ZEXPORT    gzwrite OF((gzFile file,
1147      Writes the given number of uncompressed bytes into the compressed file.
1152 ZEXTERN int ZEXPORTVA   gzprintf OF((gzFile file, const char *format, ...));
1154      Converts, formats, and writes the args to the compressed file under
1165 ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
1167       Writes the given null-terminated string to the compressed file, excluding
1172 ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));
1174       Reads bytes from the compressed file until len-1 characters are read, or
1175    a newline character is read and transferred to buf, or an end-of-file
1181 ZEXTERN int ZEXPORT    gzputc OF((gzFile file, int c));
1183       Writes c, converted to an unsigned char, into the compressed file.
1187 ZEXTERN int ZEXPORT    gzgetc OF((gzFile file));
1189       Reads one byte from the compressed file. gzgetc returns this byte
1190    or -1 in case of end of file or error.
1193 ZEXTERN int ZEXPORT    gzungetc OF((int c, gzFile file));
1203 ZEXTERN int ZEXPORT    gzflush OF((gzFile file, int flush));
1205      Flushes all pending output into the compressed file. The parameter
1213 ZEXTERN z_off_t ZEXPORT    gzseek OF((gzFile file,
1217    given compressed file. The offset represents a number of bytes in the
1220      If the file is opened for reading, this function is emulated but can be
1221    extremely slow. If the file is opened for writing, only forward seeks are
1227    particular if the file is opened for writing and the new starting position
1231 ZEXTERN int ZEXPORT    gzrewind OF((gzFile file));
1233      Rewinds the given file. This function is supported only for reading.
1235    gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
1238 ZEXTERN z_off_t ZEXPORT    gztell OF((gzFile file));
1241    given compressed file. This position represents a number of bytes in the
1244    gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
1247 ZEXTERN int ZEXPORT gzeof OF((gzFile file));
1253 ZEXTERN int ZEXPORT gzdirect OF((gzFile file));
1255      Returns 1 if file is being read directly without decompression, otherwise
1259 ZEXTERN int ZEXPORT    gzclose OF((gzFile file));
1261      Flushes all pending output if necessary, closes the compressed file
1266 ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));
1269    given compressed file. errnum is set to zlib error number. If an
1270    error occurred in the file system and not in the compression library,
1275 ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));
1277      Clears the error and end-of-file flags for file. This is analogous to the
1279    file that is being written concurrently.