Documentation
¶
Overview ¶
Package flate implements the DEFLATE compressed data format, described in RFC 1951. The gzip and zlib packages implement access to DEFLATE-based file formats.
Index ¶
Constants ¶
const ( NoCompression = 0 BestSpeed = 1 BestCompression = 9 DefaultCompression = -1 )
Variables ¶
This section is empty.
Functions ¶
func NewReader ¶
func NewReader(r io.Reader) io.ReadCloser
NewReader returns a new ReadCloser that can be used to read the uncompressed version of r. It is the caller's responsibility to call Close on the ReadCloser when finished reading.
func NewReaderDict ¶
func NewReaderDict(r io.Reader, dict []byte) io.ReadCloser
NewReaderDict is like NewReader but initializes the reader with a preset dictionary. The returned Reader behaves as if the uncompressed data stream started with the given dictionary, which has already been read. NewReaderDict is typically used to read data compressed by NewWriterDict.
Types ¶
type CorruptInputError ¶
type CorruptInputError int64
A CorruptInputError reports the presence of corrupt input at a given offset.
func (CorruptInputError) Error ¶
func (e CorruptInputError) Error() string
type InternalError ¶
type InternalError string
An InternalError reports an error in the flate code itself.
func (InternalError) Error ¶
func (e InternalError) Error() string
type ReadError ¶
type ReadError struct {
Offset int64 // byte offset where error occurred
Err error // error returned by underlying Read
}
A ReadError reports an error encountered while reading input.
type Reader ¶
The actual read interface needed by NewReader. If the passed in io.Reader does not also have ReadByte, the NewReader will introduce its own buffering.
type WriteError ¶
type WriteError struct {
Offset int64 // byte offset where error occurred
Err error // error returned by underlying Write
}
A WriteError reports an error encountered while writing output.
func (*WriteError) Error ¶
func (e *WriteError) Error() string
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 NewWriter ¶
NewWriter returns a new Writer compressing data at the given level. Following zlib, levels range from 1 (BestSpeed) to 9 (BestCompression); higher levels typically run slower but compress more. Level 0 (NoCompression) does not attempt any compression; it only adds the necessary DEFLATE framing. Level -1 (DefaultCompression) uses the default compression level.
If level is in the range [-1, 9] then the error returned will be nil. Otherwise the error returned will be non-nil.
func NewWriterDict ¶
NewWriterDict is like NewWriter but initializes the new Writer with a preset dictionary. The returned Writer behaves as if the dictionary had been written to it without producing any compressed output. The compressed data written to w can only be decompressed by a Reader initialized with the same dictionary.
func (*Writer) Flush ¶
Flush flushes any pending compressed data to the underlying writer. It is useful mainly in compressed network protocols, to ensure that a remote reader has enough data to reconstruct a packet. Flush does not return until the data has been written. If the underlying writer returns an error, Flush returns that error.
In the terminology of the zlib library, Flush is equivalent to Z_SYNC_FLUSH.
Source Files