Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Compressor ¶
type Compressor = wsflate.Compressor
Compressor is an interface holding deflate compression implementation.
type Decompressor ¶
type Decompressor = wsflate.Decompressor
Decompressor is an interface holding deflate decompression implementation.
type ReadResetter ¶
ReadResetter is an optional interface that Decompressor can implement.
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Reader implements decompression from an io.Reader object using Decompressor. Essentially Reader is a thin wrapper around Decompressor interface to meet PMCE specs.
After all data has been written client should call Flush() method. If any error occurs after reading from Reader, all subsequent calls to Read() or Close() will return the error.
Reader might be reused for different io.Reader objects after its Reset() method has been called.
func (*Reader) Close ¶
Close closes Reader and a Decompressor instance used under the hood (if it implements io.Closer interface).
type WriteResetter ¶
WriteResetter is an optional interface that Compressor can implement.
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
Writer implements compression for an io.Writer object using Compressor. Essentially Writer is a thin wrapper around Compressor interface to meet PMCE specs.
After all data has been written client should call Flush() method. If any error occurs after writing to or flushing a Writer, all subsequent calls to Write(), Flush() or Close() will return the error.
Writer might be reused for different io.Writer objects after its Reset() method has been called.
func (*Writer) Close ¶
Close closes Writer and a Compressor instance used under the hood (if it implements io.Closer interface).
Source Files