Documentation
¶
Overview ¶
Package zlib implements reading and writing of zlib format compressed data, as specified in RFC 1950.
The implementation provides filters that uncompress during reading and compress during writing. For example, to write compressed data to a buffer:
var b bytes.Buffer
w, err := zlib.NewWriter(&b)
w.Write([]byte("hello, world\n"))
w.Close()
and to read that data back:
r, err := zlib.NewReader(&b) io.Copy(os.Stdout, r) r.Close()
Index ¶
Constants ¶
const ( NoCompression = flate.NoCompression BestSpeed = flate.BestSpeed BestCompression = flate.BestCompression DefaultCompression = flate.DefaultCompression )
These constants are copied from the flate package, so that code that imports "compress/zlib" does not also have to import "compress/flate".
Variables ¶
var ChecksumError os.Error = os.ErrorString("zlib checksum error")
var DictionaryError os.Error = os.ErrorString("invalid zlib dictionary")
var HeaderError os.Error = os.ErrorString("invalid zlib header")
Functions ¶
func NewReader ¶
NewReader creates a new io.ReadCloser that satisfies reads by decompressing data read from r. The implementation buffers input and may read more data than necessary from r. It is the caller's responsibility to call Close on the ReadCloser when done.
func NewReaderDict ¶
NewReaderDict is like NewReader but uses a preset dictionary. NewReaderDict ignores the dictionary if the compressed data does not refer to it.
Types ¶
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
A Writer takes data written to it and writes the compressed form of that data to an underlying writer (see NewWriter).
func NewWriterDict ¶
NewWriterDict creates a new io.WriteCloser that satisfies writes by compressing data written to w. It is the caller's responsibility to call Close on the WriteCloser when done. level is the compression level, which can be DefaultCompression, NoCompression, or any integer value between BestSpeed and BestCompression (inclusive). dict is the preset dictionary to compress with, or nil to use no dictionary.
func NewWriterLevel ¶
NewWriterLevel calls NewWriterDict with no dictionary.
Source Files