Skip to main content

Crate z_rs

Crate z_rs 

Source

Structs§

gz_header
gzip header information passed to and from zlib routines. See RFC 1952 for more details on the meanings of these fields.
z_stream
The current stream state

Enums§

gzFile_s
In the zlib C API, this structure exposes just enough of the internal state of an open gzFile to support the gzgetc C macro. Since Rust code won’t be using that C macro, we define gzFile_s as an empty structure.
internal_state

Constants§

Z_ASCII
Z_BEST_COMPRESSION
Z_BEST_SPEED
Z_BINARY
Z_BLOCK
Z_BUF_ERROR
Z_DATA_ERROR
Z_DEFAULT_COMPRESSION
Z_DEFAULT_STRATEGY
Z_DEFLATED
Z_ERRNO
Z_FILTERED
Z_FINISH
Z_FIXED
Z_FULL_FLUSH
Z_HUFFMAN_ONLY
Z_MEM_ERROR
Z_NEED_DICT
Z_NO_COMPRESSION
Z_NO_FLUSH
Z_OK
Z_PARTIAL_FLUSH
Z_RLE
Z_STREAM_END
Z_STREAM_ERROR
Z_SYNC_FLUSH
Z_TEXT
Z_TREES
Z_UNKNOWN
Z_VERSION_ERROR

Functions§

adler32
Calculates the adler32 checksum of a sequence of bytes.
adler32_combine
Combines the checksum of two slices into one.
adler32_combine64
Combines the checksum of two slices into one.
adler32_z
Calculates the adler32 checksum of a sequence of bytes.
compress
Compresses source into dest, and writes the final deflated size into destLen.
compress2
Compresses source into dest, and writes the final deflated size into destLen.
compressBound
Returns an upper bound on the compressed size after compress or compress2 on sourceLen bytes.
crc32
Calculates the crc32 checksum of a sequence of bytes.
crc32_combine
Combines the checksum of two slices into one.
crc32_combine64
Combines the checksum of two slices into one.
crc32_combine_gen
Return the operator corresponding to length len2, to be used with crc32_combine_op. len2 must be non-negative.
crc32_combine_gen64
Return the operator corresponding to length len2, to be used with crc32_combine_op. len2 must be non-negative.
crc32_combine_op
Give the same result as crc32_combine, using op in place of len2. op is is generated from len2 by crc32_combine_gen. This will be faster than crc32_combine if the generated op is used more than once.
crc32_z
Calculates the crc32 checksum of a sequence of bytes.
deflate
Compresses as much data as possible, and stops when the input buffer becomes empty or the output buffer becomes full.
deflateBound
Returns an upper bound on the compressed size after deflation of sourceLen bytes.
deflateCopy
Sets the destination stream as a complete copy of the source stream.
deflateEnd
Deallocates all dynamically allocated data structures for this stream.
deflateGetDictionary
Returns the sliding dictionary being maintained by deflate.
deflateInit2_
Initializes the state for compression
deflateInit_
Initializes the state for compression
deflateParams
Dynamically update the compression level and compression strategy.
deflatePending
Returns the number of bytes and bits of output that have been generated, but not yet provided in the available output.
deflatePrime
Inserts bits in the deflate output stream.
deflateReset
This function is equivalent to deflateEnd followed by deflateInit_, but does not free and reallocate the internal compression state.
deflateSetDictionary
Initializes the compression dictionary from the given byte sequence without producing any compressed output.
deflateSetHeader
Provides gzip header information for when a gzip stream is requested by deflateInit2_.
deflateTune
Fine tune deflate’s internal compression parameters.
get_crc_table
The CRC table used by the crc32 checksum algorithm.
gzbuffer
Set the internal buffer size used by this library’s functions for file to size. The default buffer size is 128 KB. This function must be called after gzopen or gzdopen, but before any other calls that read or write the file (including gzdirect). The buffer memory allocation is always deferred to the first read or write. Three times size in buffer space is allocated.
gzclearerr
Clear the error and end-of-file state for file.
gzclose
Close an open gzip file and free the internal data structures referenced by the file handle.
gzclose_r
Close a gzip file that was opened for reading.
gzclose_w
Close a gzip file that was opened for writing.
gzdirect
Check whether file is in direct mode (reading or writing literal bytes without compression).
gzdopen
Given an open file descriptor, prepare to read or write a gzip file. NOTE: This is similar to gzopen, but for cases where the caller already has the file open.
gzeof
Check whether a read operation has tried to read beyond the end of file.
gzerror
Retrieve the zlib error code and a human-readable string description of the most recent error on a gzip file stream.
gzflush
Flush all pending output buffered in file. The parameter flush is interpreted the same way as in the deflate function. The return value is the zlib error number (see gzerror). gzflush is permitted only when writing.
gzfread
Read and decompress up to nitems items of size size from file into buf, otherwise operating as gzread does. This duplicates the interface of C stdio’s fread(), with size_t request and return types.
gzfwrite
Compress and write nitems items of size size from buf to file, duplicating the interface of C stdio’s fwrite, with size_t request and return types.
gzgetc
Read one decompressed byte from file.
gzgetc_
Backward-compatibility alias for gzgetc.
gzgets
Read decompressed bytes from file into buf, until len-1 characters are read, or until a newline character is read and transferred to buf, or an end-of-file condition is encountered. If any characters are read or if len is one, the string is terminated with a null character. If no characters are read due to an end-of-file or len is less than one, then the buffer is left untouched.
gzoffset
Return the current compressed (actual) read or write offset of file. This offset includes the count of bytes that precede the gzip stream, for example when appending or when using gzdopen for reading. When reading, the offset does not include as yet unused buffered input. This information can
gzoffset64
Return the current compressed (actual) read or write offset of file. This offset includes the count of bytes that precede the gzip stream, for example when appending or when using gzdopen for reading. When reading, the offset does not include as yet unused buffered input. This information can
gzopen
Open a gzip file for reading or writing.
gzopen64
Open a gzip file for reading or writing.
gzprintf
Convert, format, compress, and write the variadic arguments ... to a file under control of the string format, as in fprintf.
gzputc
Compress and write c, converted to an unsigned 8-bit char, into file.
gzputs
Compress and write the given null-terminated string s to file, excluding the terminating null character.
gzread
Read and decompress up to len uncompressed bytes from file into buf. If the input file is not in gzip format, gzread copies up to len bytes into the buffer directly from the file.
gzrewind
Rewind file to the start. This function is supported only for reading.
gzseek
Set the starting position to offset relative to whence for the next gzread or gzwrite on file. The offset represents a number of bytes in the uncompressed data stream. The whence parameter is defined as in lseek(2), but only SEEK_CUR (relative to current position) and SEEK_SET (absolute from start of the uncompressed data stream) are supported.
gzseek64
Set the starting position to offset relative to whence for the next gzread or gzwrite on file. The offset represents a number of bytes in the uncompressed data stream. The whence parameter is defined as in lseek(2), but only SEEK_CUR (relative to current position) and SEEK_SET (absolute from start of the uncompressed data stream) are supported.
gzsetparams
Dynamically update the compression level and strategy for file. See the description of deflateInit2_ for the meaning of these parameters. Previously provided data is flushed before applying the parameter changes.
gztell
Return the starting position for the next gzread or gzwrite on file. This position represents a number of bytes in the uncompressed data stream, and is zero when starting, even if appending or reading a gzip stream from the middle of a file using gzdopen.
gztell64
Return the starting position for the next gzread or gzwrite on file. This position represents a number of bytes in the uncompressed data stream, and is zero when starting, even if appending or reading a gzip stream from the middle of a file using gzdopen.
gzungetc
Push c back onto the stream for file to be read as the first character on the next read. At least one character of push-back is always allowed.
gzvprintf
Convert, format, compress, and write the variable argument list to a file under control of the string format, as in vfprintf.
gzwrite
Compress and write the len uncompressed bytes at buf to file.
inflate
Decompresses as much data as possible, and stops when the input buffer becomes empty or the output buffer becomes full.
inflateBack
Decompresses as much data as possible, and stops when the input buffer becomes empty or the output buffer becomes full.
inflateBackEnd
Deallocates all dynamically allocated data structures for this stream.
inflateBackInit_
Initializes the state for decompression
inflateCopy
Sets the destination stream as a complete copy of the source stream.
inflateEnd
Deallocates all dynamically allocated data structures for this stream.
inflateGetDictionary
Returns the sliding dictionary being maintained by inflate.
inflateGetHeader
Requests that gzip header information be stored in the provided gz_header structure.
inflateInit2_
Initializes the state for decompression
inflateInit_
Initializes the state for decompression
inflateMark
Gives information about the current location of the input stream.
inflatePrime
Inserts bits in the inflate input stream.
inflateReset
Equivalent to inflateEnd followed by inflateInit_, but does not free and reallocate the internal decompression state.
inflateReset2
This function is the same as inflateReset, but it also permits changing the wrap and window size requests.
inflateSetDictionary
Initializes the decompression dictionary from the given uncompressed byte sequence.
inflateSync
Skips invalid compressed data until
uncompress
Inflates source into dest, and writes the final inflated size into destLen.
uncompress2
Inflates source into dest like uncompress, and writes the final inflated size into destLen and the number of source bytes consumed into sourceLen.
zError
Get the error message for an error. This could be the value returned by e.g. compress or inflate.
zlibCompileFlags
Return flags indicating compile-time options.
zlibVersion
The version of the zlib library.

Type Aliases§

Bytef
alloc_func
free_func
gzFile
File handle for an open gzip file.
gz_headerp
in_func
out_func
size_t
uInt
uLong
uLongf
voidp
voidpc
voidpf
z_off64_t
z_off_t
z_streamp