©
本文档使用
php中文网手册 发布
import "compress/zlib"
概述
索引
示例
概述
打包 zlib 实现了读取和写入zlib格式压缩数据，如 RFC 1950中所述。
实现提供了在读取和压缩期间解压缩的过滤器。例如，要将压缩数据写入缓冲区：
var b bytes.Buffer
w := zlib.NewWriter(&b)w.Write([]byte("hello, world\n"))w.Close()并读回数据：
r, err := zlib.NewReader(&b)io.Copy(os.Stdout, r)r.Close()
参数
Constants（常量）
Variables（变量）
func NewReader(r io.Reader) (io.ReadCloser, error)
func NewReaderDict(r io.Reader, dict []byte) (io.ReadCloser, error)
type Resetter
type Writer
func NewWriter(w io.Writer) *Writer
func NewWriterLevel(w io.Writer, level int) (*Writer, error)
func NewWriterLevelDict(w io.Writer, level int, dict []byte) (*Writer, error)
func (z *Writer) Close() error
func (z *Writer) Flush() error
func (z *Writer) Reset(w io.Writer)
func (z *Writer) Write(p []byte) (n int, err error)
示例
NewReader NewWriter
打包文件
reader.go writer.go
常量
这些常量是从 flate 包中复制的，因此导入“compress/zlib”的代码不需要导入“compress/flate”。
const ( NoCompression = flate.NoCompression BestSpeed = flate.BestSpeed BestCompression = flate.BestCompression DefaultCompression = flate.DefaultCompression HuffmanOnly = flate.HuffmanOnly)
变量
var ( // 读取具有无效校验和的ZLIB数据时会返回ErrChecksum。
ErrChecksum = errors.New("zlib: invalid checksum") // 读取具有无效字典的ZLIB数据时，会返回ErrDictionary。
ErrDictionary = errors.New("zlib: invalid dictionary") // 读取包含无效标题的ZLIB数据时，会返回ErrHeader。
ErrHeader = errors.New("zlib: invalid header"))func NewReader
func NewReader(r io.Reader) (io.ReadCloser, error)
NewReader 创建一个新的 ReadCloser。从返回的 ReadCloser 读取并解压缩来自r的数据。如果 r 没有实现 io.ByteReader，解压缩程序可能会读取比r更多的数据。调用者有责任在完成时调用ReadCloser 上的 Close。
NewReader 返回的 ReadCloser 也实现了 Resetter。
示例
package mainimport ("bytes""compress/zlib""io""os")func main() {
buff := []byte{120, 156, 202, 72, 205, 201, 201, 215, 81, 40, 207,47, 202, 73, 225, 2, 4, 0, 0, 255, 255, 33, 231, 4, 147}
b := bytes.NewReader(buff)
r, err := zlib.NewReader(b)if err != nil {panic(err)}
io.Copy(os.Stdout, r)
r.Close()}func NewReaderDict
func NewReaderDict(r io.Reader, dict []byte) (io.ReadCloser, error)
NewReaderDict 与 NewReader 类似，但使用预设字典。如果压缩数据没有引用它，NewReaderDict 会忽略该字典。如果压缩数据引用不同的字典，则 NewReaderDict 返回 ErrDictionary。
NewReaderDict 返回的 ReadCloser 也实现了 Resetter。
type Resetter
重置器重置由 NewReader 或 NewReaderDict 返回的 ReadCloser 以切换到新的底层 Reader。这允许重新使用 ReadCloser 而不是分配新的。
type Resetter interface { // 重置会丢弃任何缓冲数据，并将重置器重置为好像它一样 // 最新与给定的读者初始化。 Reset(r io.Reader, dict []byte) error}type Writer
Writer 将写入数据的数据写入底层写入器（请参阅 NewWriter）。
type Writer struct { // 包含过滤或未导出的字段}func NewWriter
func NewWriter(w io.Writer) *Writer
NewWriter 创建一个新的 Writer。写入返回的 Writer 被压缩并写入 w。
调用者有责任在完成时调用 WriteCloser 上的 Close。写入可能会被缓冲，直到关闭才会被刷新。
示例
package mainimport ("bytes""compress/zlib""fmt")func main() {var b bytes.Buffer
w := zlib.NewWriter(&b)
w.Write([]byte("hello, world\n"))
w.Close()
fmt.Println(b.Bytes())}func NewWriterLevel
func NewWriterLevel(w io.Writer, level int) (*Writer, error)
NewWriterLevel 就像 NewWriter，但指定压缩级别而不是假设 DefaultCompression。
压缩级别可以是DefaultCompression，NoCompression， HuffmanOnly 或 BestSpeed 和 BestCompression 之间的任何整数值。如果级别有效，返回的错误将为零。
func NewWriterLevelDict
func NewWriterLevelDict(w io.Writer, level int, dict []byte) (*Writer, error)
NewWriterLevelDict 与 NewWriterLevel 类似，但指定要压缩的字典。
字典可能是零。如果没有，则在 Writer 关闭之前不应修改其内容。
func (*Writer) Close
func (z *Writer) Close() error
关闭Writer，将任何未写入的数据刷新到基础 io.Writer，但不关闭基础 io.Writer。
func (*Writer) Flush
func (z *Writer) Flush() error
Flush Writer 到其基础 io.Writer。
func (*Writer) Reset
func (z *Writer) Reset(w io.Writer)
重置清除Writer z 的状态，使其等于 NewWriterLevel 或 NewWriterLevelDict 的初始状态，并且写入 w。
func (*Writer) Write
func (z *Writer) Write(p []byte) (n int, err error)
写入一个压缩形式的 p 到底层的 io.Writer 。在写入器关闭或明确刷新之前，压缩的字节不一定会被刷新。