package zlib

Import Path
	compress/zlib (on golang.org and go.dev)

Dependency Relation
	imports 8 packages, and imported by 4 packages

Involved Source Files
	   d➜ reader.go
		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 := 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()
	      writer.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Resetter (interface)
		Resetter resets a ReadCloser returned by NewReader or NewReaderDict
		to switch to a new underlying Reader. This permits reusing a ReadCloser
		instead of allocating a new one.

		Methods (only one)
			( T) Reset(r io.Reader, dict []byte) error
				Reset discards any buffered data and resets the Resetter as if it was
				newly initialized with the given reader.

		Implemented By (at least one exported)
			 compress/flate.Resetter (interface)
		Implements (at least one exported)
			 T : compress/flate.Resetter

	 type Writer (struct)
		A Writer takes data written to it and writes the compressed
		form of that data to an underlying writer (see NewWriter).

		Methods (total 4)
			(*T) Close() error
				Close closes the Writer, flushing any unwritten data to the underlying
				io.Writer, but does not close the underlying io.Writer.

			(*T) Flush() error
				Flush flushes the Writer to its underlying io.Writer.

			(*T) Reset(w io.Writer)
				Reset clears the state of the Writer z such that it is equivalent to its
				initial state from NewWriterLevel or NewWriterLevelDict, but instead writing
				to w.

			(*T) Write(p []byte) (n int, err error)
				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.

		Implements (at least 3)
			*T : io.Closer
			*T : io.WriteCloser
			*T : io.Writer
		As Outputs Of (at least 3)
			func NewWriter(w io.Writer) *Writer
			func NewWriterLevel(w io.Writer, level int) (*Writer, error)
			func NewWriterLevelDict(w io.Writer, level int, dict []byte) (*Writer, error)


Package-Level Functions (total 5)

	 func NewReader(r io.Reader) (io.ReadCloser, error)
		NewReader creates a new ReadCloser.
		Reads from the returned ReadCloser read and decompress data from r.
		If r does not implement io.ByteReader, the decompressor may read more
		data than necessary from r.
		It is the caller's responsibility to call Close on the ReadCloser when done.

		The ReadCloser returned by NewReader also implements Resetter.

	 func NewReaderDict(r io.Reader, dict []byte) (io.ReadCloser, error)
		NewReaderDict is like NewReader but uses a preset dictionary.
		NewReaderDict ignores the dictionary if the compressed data does not refer to it.
		If the compressed data refers to a different dictionary, NewReaderDict returns ErrDictionary.

		The ReadCloser returned by NewReaderDict also implements Resetter.

	 func NewWriter(w io.Writer) *Writer
		NewWriter creates a new Writer.
		Writes to the returned Writer are compressed and written to w.

		It is the caller's responsibility to call Close on the Writer when done.
		Writes may be buffered and not flushed until Close.

	 func NewWriterLevel(w io.Writer, level int) (*Writer, error)
		NewWriterLevel is like NewWriter but specifies the compression level instead
		of assuming DefaultCompression.

		The compression level can be DefaultCompression, NoCompression, HuffmanOnly
		or any integer value between BestSpeed and BestCompression inclusive.
		The error returned will be nil if the level is valid.

	 func NewWriterLevelDict(w io.Writer, level int, dict []byte) (*Writer, error)
		NewWriterLevelDict is like NewWriterLevel but specifies a dictionary to
		compress with.

		The dictionary may be nil. If not, its contents should not be modified until
		the Writer is closed.


Package-Level Variables (total 3)

	  var ErrChecksum error
		ErrChecksum is returned when reading ZLIB data that has an invalid checksum.

	  var ErrDictionary error
		ErrDictionary is returned when reading ZLIB data that has an invalid dictionary.

	  var ErrHeader error
		ErrHeader is returned when reading ZLIB data that has an invalid header.


Package-Level Constants (total 5)

	const BestCompression = 9
		These constants are copied from the flate package, so that code that imports
		"compress/zlib" does not also have to import "compress/flate".

	const BestSpeed = 1
		These constants are copied from the flate package, so that code that imports
		"compress/zlib" does not also have to import "compress/flate".

	const DefaultCompression = -1
		These constants are copied from the flate package, so that code that imports
		"compress/zlib" does not also have to import "compress/flate".

	const HuffmanOnly = -2
		These constants are copied from the flate package, so that code that imports
		"compress/zlib" does not also have to import "compress/flate".

	const NoCompression = 0
		These constants are copied from the flate package, so that code that imports
		"compress/zlib" does not also have to import "compress/flate".

The pages are generated with Golds v0.2.5. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.