package lzw
import "compress/lzw"
Package lzw 实现了 Lempel-Ziv-Welch 压缩数据格式, 该格式在 T. A. Welch 的 “A Technique for High-Performance Data Compression”, Computer, 17(6) (June 1984), pp 8-19 中有描述。
具体而言,它实现了 GIF 和 PDF 文件格式所使用的 LZW, 这意味着可变宽度编码最多可达 12 位,并且前两个 非字面量编码分别是清除码和 EOF 码。
TIFF 文件格式使用了 LZW 算法的一个类似但不兼容的版本。 参见 golang.org/x/image/tiff/lzw 包中的实现。
Index
- func NewReader(r io.Reader, order Order, litWidth int) io.ReadCloser
- func NewWriter(w io.Writer, order Order, litWidth int) io.WriteCloser
- type Order
- type Reader
- type Writer
Functions
func NewReader
func NewReader(r io.Reader, order Order, litWidth int) io.ReadCloser
NewReader 创建一个新的 io.ReadCloser。 从返回的 io.ReadCloser 读取会读取并解压来自 r 的数据。 如果 r 没有同时实现 io.ByteReader, 解压器可能会从 r 读取超出所需的数据。 读取完成后,调用者有责任对 ReadCloser 调用 Close。 用于字面量编码的位数 litWidth 必须位于 范围 [2,8] 内,且通常为 8。它必须等于 压缩时使用的 litWidth。
保证返回的 io.ReadCloser 的底层类型 是 *Reader。
func NewWriter
func NewWriter(w io.Writer, order Order, litWidth int) io.WriteCloser
NewWriter 创建一个新的 io.WriteCloser。 写入返回的 io.WriteCloser 的数据会被压缩并写入 w。 调用者负责在写入完成后对 WriteCloser 调用 Close。 用于字面量 code 的比特数 litWidth 必须在 [2,8] 范围内,通常为 8。 输入字节必须小于 1<<litWidth。
保证返回的 io.WriteCloser 的底层类型是 *Writer。
Types
type Order
type Order int
Order 指定 LZW 数据流中的位顺序。
const ( // LSB 表示最低有效位在前(Least Significant Bits first),GIF 文件格式即使用该顺序。 LSB Order = iota // MSB 表示最高有效位在前(Most Significant Bits first),TIFF 和 PDF // 文件格式即使用该顺序。 MSB )
type Reader
type Reader struct { // contains filtered or unexported fields }
Reader 是一个 io.Reader,可用于读取 LZW 格式的压缩数据。
func (*Reader) Close
func (r *Reader) Close() error
Close 关闭 Reader,并为之后的任何读取操作返回一个错误。 它不会关闭底层的 io.Reader。
func (*Reader) Read
func (r *Reader) Read(b []byte) (int, error)
Read 实现 io.Reader,从其底层 reader 读取未压缩的字节。
func (*Reader) Reset
func (r *Reader) Reset(src io.Reader, order Order, litWidth int)
Reset 清除 Reader 的状态,并允许它作为一个新的 Reader 再次被复用。
type Writer
type Writer struct { // contains filtered or unexported fields }
Writer 是一个 LZW 压缩器。它把数据的压缩形式写入底层 writer (参见 NewWriter)。
func (*Writer) Close
func (w *Writer) Close() error
Close 关闭 Writer,刷新所有待处理的输出。它不会关闭 w 的底层 writer。
func (*Writer) Reset
func (w *Writer) Reset(dst io.Writer, order Order, litWidth int)
Reset 清除 Writer 的状态,使其可以作为一个新的 Writer 再次复用。
func (*Writer) Write
func (w *Writer) Write(p []byte) (n int, err error)
Write 把 p 的压缩表示写入 w 的底层 writer。