Skip to content

REFERENCE / ZLIB × LEAN

API contracts

The complete public-interface index

95 default-build entries, plus Windows gzopen_w. Every entry retains its signature, domain, preconditions, results, memory effects, and error paths. Documentary contracts and registered goals may have different scopes; both are preserved.

Find a function or contract

GroupBuild96 entries

adler32Update an Adler-32 checksum using a 32-bit byte count.Checksums adler32_combineCompute the Adler-32 of A followed by B without reading either sequence.Checksums adler32_combine64Compute the Adler-32 of A followed by B with an explicit 64-bit length.Checksums adler32_zUpdate an Adler-32 checksum with a byte range, or obtain its initial value.Checksums compressThe uLong compressor at the default level.Buffers and library information compress2The uLong form of compress2_z.Buffers and library information compress2_zCompresses the input into one complete zlib stream at the requested level.Buffers and library information compressBoundThe uLong form of the numeric bound.Buffers and library information compressBound_zCalculates the numeric bound used to size a default zlib compression buffer.Buffers and library information compress_zCompresses at the default level (-1, selecting level 6).Buffers and library information crc32Update a CRC-32 checksum using a 32-bit byte count.Checksums crc32_combineCompute the CRC-32 of A followed by B using the ordinary offset type.Checksums crc32_combine64Compute the CRC-32 of A followed by B without reading either sequence.Checksums crc32_combine_genGenerate a CRC combination operator using the ordinary offset type.Checksums crc32_combine_gen64Generate an operator for repeated CRC combinations with the same B length.Checksums crc32_combine_opCompute the CRC-32 of A followed by B using a previously generated operator.Checksums crc32_zUpdate a CRC-32 checksum with a byte range, or obtain its initial value.Checksums deflateAccept input and deliver part or all of a valid compressed stream.Compression streams deflateBoundReturn the uLong form of the compression bound.Compression streams deflateBound_zCompute a size bound using the stream's current configuration and wrapper.Compression streams deflateCopyCreate an independent compressor with the same compression progress.Compression streams deflateEndRelease the compressor, discarding any unfinished work.Compression streams deflateGetDictionaryRead the current compression history, including accepted lookahead.Compression streams deflateInit2_Start a compressor with a chosen wrapper and compression settings.Compression streams deflateInit_Start a compressor with the default zlib wrapper and compression settings.Compression streams deflateParamsChange level and strategy, finishing the old block when needed.Compression streams deflatePendingReport output waiting inside the compressor.Compression streams deflatePrimePrefix raw compression output with a caller-supplied bit fragment.Compression streams deflateResetReuse a stream for new compression with empty history.Compression streams deflateResetKeepRestart output and progress counters while retaining compression history.Compression streams deflateSetDictionaryLoad preset bytes as compression history without emitting them as input data.Compression streams deflateSetHeaderSelect the header for the next gzip stream.Compression streams deflateTuneSet the four expert match-search tuning values.Compression streams deflateUsedReport the last byte's bit use at the most recent byte-boundary flush.Compression streams get_crc_tableReturn the library's byte-at-a-time CRC table.Checksums gzbufferChoose the requested buffer size before buffers exist.Gzip files gzclearerrClear recorded error information and rearm reader EOF detection.Gzip files gzcloseClose a reader or finish and close a writer.Gzip files gzclose_rRelease a reader and close its descriptor without further decompression.Gzip files gzclose_wFinish buffered output, release a writer and close its descriptor.Gzip files gzdirectReport whether the handle is using transparent data.Gzip files gzdopenWrap an existing descriptor without opening or duplicating it.Gzip files gzeofQuery whether a reader has tried to read beyond available data.Gzip files gzerrorRead the handle's current error code and message.Gzip files gzflushProcess buffered output using the requested flush mode.Gzip files gzfreadRead up to nitems items of size uncompressed bytes.Gzip files gzfwriteAccept up to nitems items of size uncompressed bytes.Gzip files gzgetcRead one uncompressed byte as an unsigned value.Gzip files gzgetc_Provide the exported wrapper for single-byte reading.Gzip files gzgetsRead a line fragment and terminate it with NUL.Gzip files gzoffsetQuery physical file offset using z_off_t.Gzip files gzoffset64Query the underlying physical file offset.Gzip files gzopenOpen a path for reading, writing or appending.Gzip files gzopen64Open using the large-file entry point.Gzip files gzopen_wOpen a Windows wide-character path.Gzip files · Windows gzprintfFormat arguments and accept the resulting bytes for output.Gzip files gzputcAccept the low eight bits of c for output.Gzip files gzputsAccept a NUL-terminated string, excluding its terminator.Gzip files gzreadRead up to len uncompressed bytes.Gzip files gzrewindReset a reader to its saved descriptor start.Gzip files gzseekRequest an uncompressed position through the ordinary offset type.Gzip files gzseek64Request an uncompressed position relative to start or current position.Gzip files gzsetparamsRequest a new compression level and strategy for subsequent input.Gzip files gztellQuery logical uncompressed position using z_off_t.Gzip files gztell64Query the current logical uncompressed position.Gzip files gzungetcPush one byte onto a reader's uncompressed input.Gzip files gzvprintfFormat a va_list and accept the result for output.Gzip files gzwriteAccept len uncompressed bytes for output.Gzip files inflateConsume compressed bytes and write decoded bytes, preserving state across calls.Decompression streams inflateBackPurpose. Decode one complete raw stream through the input and output callbacks.Callback decoding inflateBackEndPurpose. Release the state allocated by callback init.Callback decoding inflateBackInit_Purpose. Allocate decoder state and attach the caller's window. The inflateBackInit macro supplies version and stream_size.Callback decoding inflateCodesUsedReport the decoding-table entries used so far. This is an undocumented entry point.Decompression streams inflateCopyCreate a decoder that can resume from the source position.Decompression streams inflateEndRelease decoder storage, including when decoding was abandoned or failed.Decompression streams inflateGetDictionaryRead the retained sliding history, oldest byte first.Decompression streams inflateGetHeaderRegister caller storage for the next gzip header.Decompression streams inflateInit2_Create a decoder with a selected wrapper and window.Decompression streams inflateInit_Create a zlib decoder with a 32 KiB maximum window.Decompression streams inflateMarkReport the current code position for indexing.Decompression streams inflatePrimeSupply bits before the next input byte, or clear buffered bits.Decompression streams inflateResetStart a new independent compressed stream using the existing configuration.Decompression streams inflateReset2Reset and select a new wrapper and maximum window size.Decompression streams inflateResetKeepRestart decoding while retaining history. This is an undocumented entry point.Decompression streams inflateSetDictionaryInstall or amend the bytes available for backward matches.Decompression streams inflateSyncSearch for a possible full-flush boundary after damaged input.Decompression streams inflateSyncPointTest whether stored-block length bytes are the next thing expected.Decompression streams inflateUndermineRequest the optional permissive-distance mode. This is an undocumented entry point.Decompression streams inflateValidateEnable or disable wrapper checksum and gzip length validation.Decompression streams uncompressThe uLong decoder without a consumed-input count.Buffers and library information uncompress2The uLong decoder with an input-consumption count.Buffers and library information uncompress2_zDecodes the first zlib stream and reports both output size and input consumption.Buffers and library information uncompress_zDecodes without exposing the consumed-input count.Buffers and library information zErrorReturns the text associated with a zlib result code.Buffers and library information zlibCompileFlagsReports the build's type sizes and compile-time options.Buffers and library information zlibVersionReturns the linked library's release string.Buffers and library information