mirror of
https://github.com/golang/go
synced 2024-11-21 21:14:47 -07:00
compress: add comments to gzip and zlib.
Fixes #2939. R=rsc, r CC=golang-dev https://golang.org/cl/5655050
This commit is contained in:
parent
e0b2ce3401
commit
18f518362b
@ -34,8 +34,12 @@ func makeReader(r io.Reader) flate.Reader {
|
||||
return bufio.NewReader(r)
|
||||
}
|
||||
|
||||
var ErrHeader = errors.New("invalid gzip header")
|
||||
var ErrChecksum = errors.New("gzip checksum error")
|
||||
var (
|
||||
// ErrChecksum is returned when reading GZIP data that has an invalid checksum.
|
||||
ErrChecksum = errors.New("gzip: invalid checksum")
|
||||
// ErrHeader is returned when reading GZIP data that has an invalid header.
|
||||
ErrHeader = errors.New("gzip: invalid header")
|
||||
)
|
||||
|
||||
// The gzip file stores a header giving metadata about the compressed file.
|
||||
// That header is exposed as the fields of the Writer and Reader structs.
|
||||
|
@ -130,6 +130,8 @@ func (z *Writer) writeString(s string) (err error) {
|
||||
return err
|
||||
}
|
||||
|
||||
// Write writes a compressed form of p to the underlying io.Writer. The
|
||||
// compressed bytes are not necessarily flushed until the Writer is closed.
|
||||
func (z *Writer) Write(p []byte) (int, error) {
|
||||
if z.err != nil {
|
||||
return 0, z.err
|
||||
|
@ -34,9 +34,14 @@ import (
|
||||
|
||||
const zlibDeflate = 8
|
||||
|
||||
var ErrChecksum = errors.New("zlib checksum error")
|
||||
var ErrHeader = errors.New("invalid zlib header")
|
||||
var ErrDictionary = errors.New("invalid zlib dictionary")
|
||||
var (
|
||||
// ErrChecksum is returned when reading ZLIB data that has an invalid checksum.
|
||||
ErrChecksum = errors.New("zlib: invalid checksum")
|
||||
// ErrDictionary is returned when reading ZLIB data that has an invalid dictionary.
|
||||
ErrDictionary = errors.New("zlib: invalid dictionary")
|
||||
// ErrHeader is returned when reading ZLIB data that has an invalid header.
|
||||
ErrHeader = errors.New("zlib: invalid header")
|
||||
)
|
||||
|
||||
type reader struct {
|
||||
r flate.Reader
|
||||
|
@ -119,6 +119,9 @@ func (z *Writer) writeHeader() (err error) {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Write writes a compressed form of p to the underlying io.Writer. The
|
||||
// compressed bytes are not necessarily flushed until the Writer is closed or
|
||||
// explicitly flushed.
|
||||
func (z *Writer) Write(p []byte) (n int, err error) {
|
||||
if !z.wroteHeader {
|
||||
z.err = z.writeHeader()
|
||||
@ -138,7 +141,7 @@ func (z *Writer) Write(p []byte) (n int, err error) {
|
||||
return
|
||||
}
|
||||
|
||||
// Flush flushes the underlying compressor.
|
||||
// Flush flushes the Writer to its underlying io.Writer.
|
||||
func (z *Writer) Flush() error {
|
||||
if !z.wroteHeader {
|
||||
z.err = z.writeHeader()
|
||||
|
Loading…
Reference in New Issue
Block a user