跳到正文
参考文档 / ZLIB × LEAN

API 契约

完整公开接口索引

95 个默认构建入口,另含 Windows gzopen_w。各条完整保留签名、定义域、前置条件、结果、内存效果和错误路径。文档中的契约与 Lean 目标的范围可能不同,两者都原样呈现。

adler3232 位校验和值用 32 位字节计数更新 Adler-32。校验和adler32_combine校验和值或长度拒绝值计算 A 后接 B 的 Adler-32,而不读取任一序列。校验和adler32_combine64校验和值或长度拒绝值使用显式 64 位长度计算 A 后接 B 的 Adler-32。校验和adler32_z32 位校验和值用一段字节更新 Adler-32,或取得初始值。校验和compresszlib 状态码;输出长度另行写回默认级别的 uLong 压缩条目。缓冲区与库信息compress2zlib 状态码;输出长度另行写回compress2_z 的 uLong 形式。缓冲区与库信息compress2_zzlib 状态码;输出长度另行写回按请求级别,将输入压缩为一个完整 zlib 流。缓冲区与库信息compressBound饱和的压缩容量数值数值上界的 uLong 形式。缓冲区与库信息compressBound_z饱和的压缩容量数值计算为默认 zlib 压缩缓冲区确定容量所用的数值上界。缓冲区与库信息compress_zzlib 状态码;输出长度另行写回按默认级别压缩(-1,选择级别 6)。缓冲区与库信息crc3232 位校验和值用 32 位字节计数更新 CRC-32。校验和crc32_combine校验和值或长度拒绝值使用普通偏移类型计算 A 后接 B 的 CRC-32。校验和crc32_combine64校验和值或长度拒绝值计算 A 后接 B 的 CRC-32,而不读取任一序列。校验和crc32_combine_genCRC 组合算子使用普通偏移类型生成 CRC 组合算子。校验和crc32_combine_gen64CRC 组合算子生成一个算子,供 B 长度相同的多次 CRC 组合复用。校验和crc32_combine_opCRC-32 校验和值或算子拒绝值使用预先生成的算子,计算 A 后接 B 的 CRC-32。校验和crc32_z32 位校验和值用一段字节更新 CRC-32,或取得初始值。校验和deflatezlib 状态码接受输入,交付有效压缩流的一部分或全部。压缩流deflateBound输出容量上界(字节)返回压缩上界的 uLong 形式。压缩流deflateBound_z输出容量上界(字节)根据流当前的配置和封装计算大小上界。压缩流deflateCopyzlib 状态码创建压缩进度相同、彼此独立的压缩器。压缩流deflateEndzlib 状态码释放压缩器,丢弃任何未完成工作。压缩流deflateGetDictionaryzlib 状态码读取当前压缩历史,包括已接受的预读输入。压缩流deflateInit2_zlib 状态码选择封装和压缩设置,启动压缩器。压缩流deflateInit_zlib 状态码使用默认 zlib 封装和压缩设置启动压缩器。压缩流deflateParamszlib 状态码更改级别和策略,必要时先完成旧块。压缩流deflatePendingzlib 状态码查询压缩器内部等待输出的数据。压缩流deflatePrimezlib 状态码在裸流的压缩输出前添加调用者提供的位片段。压缩流deflateResetzlib 状态码复用流,以空历史开始新的压缩。压缩流deflateResetKeepzlib 状态码重新开始输出和进度计数,同时保留压缩历史。压缩流deflateSetDictionaryzlib 状态码将预置字节载入压缩历史,不把它们作为输入数据输出。压缩流deflateSetHeaderzlib 状态码选择下一个 gzip 流的头部。压缩流deflateTunezlib 状态码设置供专家使用的四个匹配搜索调优值。压缩流deflateUsedzlib 状态码查询最近一次字节边界刷新中,最后一个字节的位使用量。压缩流get_crc_table借用的只读表指针返回库逐字节计算 CRC 使用的表。校验和gzbuffer零/负一控制结果在缓冲区存在前选择请求大小。gzip 文件gzclearerr无返回值的状态重置清除已记录错误信息,并重新启用读取句柄的 EOF 检测。gzip 文件gzclosezlib 关闭状态码关闭读取句柄,或完成输出后关闭写入句柄。gzip 文件gzclose_rzlib 关闭状态码释放读取句柄并关闭其描述符,不继续解压。gzip 文件gzclose_wzlib 关闭状态码完成缓冲输出、释放写入句柄并关闭描述符。gzip 文件gzdirect透明模式标志,不是错误状态报告句柄是否使用透明数据。gzip 文件gzdopen拥有资源的句柄或失败标记包装已有描述符,不打开或复制它。gzip 文件gzeof越过 EOF 标志查询读取句柄是否曾尝试读取可用数据之后的内容。gzip 文件gzerror借用的消息指针;错误码写入可选输出参数读取句柄的当前错误码和消息。gzip 文件gzflushzlib 状态码按请求的刷新模式处理缓冲输出。gzip 文件gzfread已读取的完整数据项数读取至多 nitems 个数据项,每项为 size 个未压缩字节。gzip 文件gzfwrite已接受的完整数据项数接受至多 nitems 个数据项,每项为 size 个未压缩字节。gzip 文件gzgetc无符号字节值,或失败/EOF 标记将一个未压缩字节作为无符号值读取。gzip 文件gzgetc_无符号字节值,或失败/EOF 标记提供单字节读取的导出包装函数。gzip 文件gzgets调用者缓冲区指针,或 NULL读取一个行片段,并以 NUL 结尾。gzip 文件gzoffset物理文件偏移,或失败标记使用 z_off_t 查询物理文件偏移。gzip 文件gzoffset64物理文件偏移,或失败标记查询底层物理文件偏移。gzip 文件gzopen拥有资源的句柄或失败标记打开路径,用于读取、写入或追加。gzip 文件gzopen64拥有资源的句柄或失败标记通过大文件入口打开。gzip 文件gzopen_w拥有资源的句柄或失败标记打开 Windows 宽字符路径。gzip 文件 · Windowsgzprintf格式化字节数、零或 zlib 错误码格式化参数,并接受所得字节用于输出。gzip 文件gzputc已接受字节值或失败标记接受 c 的低八位用于输出。gzip 文件gzputs已接受字符串字节数或失败标记接受以 NUL 结尾的字符串,不包含终止符。gzip 文件gzread已读取的未压缩字节数,或失败标记读取至多 len 个未压缩字节。gzip 文件gzrewind回到起点的成功/失败标记将读取句柄重置到保存的描述符起点。gzip 文件gzseek请求的未压缩位置,或失败标记通过普通偏移类型请求未压缩位置。gzip 文件gzseek64请求的未压缩位置,或失败标记请求相对于起点或当前位置的未压缩位置。gzip 文件gzsetparamszlib 状态码为后续输入请求新的压缩级别和策略。gzip 文件gztell逻辑未压缩位置;-1 也可能是失败标记使用 z_off_t 查询逻辑未压缩位置。gzip 文件gztell64逻辑未压缩位置;-1 也可能是失败标记查询当前逻辑未压缩位置。gzip 文件gzungetc原始非负参数,或失败标记将一个字节压回读取句柄的未压缩输入。gzip 文件gzvprintf格式化字节数、零或 zlib 错误码格式化 va_list,并接受结果用于输出。gzip 文件gzwrite已接受的未压缩字节数接受 len 个未压缩字节用于输出。gzip 文件inflatezlib 状态码消费压缩字节,写入解码字节,跨调用保留状态。解压流inflateBackzlib 状态码用途。 通过输入和输出回调解码一个完整的裸流。回调解码inflateBackEndzlib 状态码用途。 释放回调初始化所分配的状态。回调解码inflateBackInit_zlib 状态码用途。 分配解码器状态并关联调用者的窗口。 inflateBackInit 宏提供 version 和 stream_size。回调解码inflateCodesUsed解码表项计数或错误哨兵查询目前使用的解码表项数。这是一个未文档化的入口点。这里的单位是表项,不是比特或字节:一个表项记录一次查表所得的符号或后续操作。解压流inflateCopyzlib 状态码创建可以从源位置继续的解码器。解压流inflateEndzlib 状态码释放解码器存储,包括解码被放弃或失败的情况。解压流inflateGetDictionaryzlib 状态码读取保留的滑动历史,从最旧字节开始。解压流inflateGetHeaderzlib 状态码挂接调用者存储,用于下一个 gzip 头。解压流inflateInit2_zlib 状态码创建采用所选封装和窗口的解码器。解压流inflateInit_zlib 状态码创建最大窗口为 32 KiB 的 zlib 解码器。解压流inflateMark打包的位置和进度,或重合的错误哨兵查询当前码位置,用于索引。解压流inflatePrimezlib 状态码在下一个输入字节之前提供位,或清空缓冲位。解压流inflateResetzlib 状态码使用现有配置开始新的独立压缩数据流。解压流inflateReset2zlib 状态码重置并选择新的封装和最大窗口大小。解压流inflateResetKeepzlib 状态码重新开始解码,同时保留历史。这是一个未文档化的入口点。解压流inflateSetDictionaryzlib 状态码设置或补充可供向后匹配使用的字节。解压流inflateSynczlib 状态码输入受损后,搜索可能的完全刷新边界。解压流inflateSyncPoint状态查询值或错误码检查接下来是否正在等待存储块的长度字节。解压流inflateUnderminezlib 状态码请求可选的宽松距离模式。这是一个未文档化的入口点。解压流inflateValidatezlib 状态码启用或关闭封装校验和及 gzip 长度校验。解压流uncompresszlib 状态码;计数由长度参数报告不报告已消费输入计数的 uLong 解码条目。缓冲区与库信息uncompress2zlib 状态码;计数由长度参数报告报告输入消费量的 uLong 解码条目。缓冲区与库信息uncompress2_zzlib 状态码;计数由长度参数报告解码第一个 zlib 流,并报告输出大小和输入消费量。缓冲区与库信息uncompress_zzlib 状态码;计数由长度参数报告解码,但不公开已消费输入计数。缓冲区与库信息zError借用的不可变错误文本指针返回 zlib 结果码对应的文本。缓冲区与库信息zlibCompileFlags构建信息位字段报告构建的类型大小和编译期选项。缓冲区与库信息zlibVersion借用的不可变版本字符串指针返回已链接库的发布版本字符串。缓冲区与库信息
ZLIB × LEAN

目录

正在阅读API 契约