package lzw

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

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files
	   d➜ reader.go
		Package lzw implements the Lempel-Ziv-Welch compressed data format,
		described in T. A. Welch, ``A Technique for High-Performance Data
		Compression'', Computer, 17(6) (June 1984), pp 8-19.

		In particular, it implements LZW as used by the GIF and PDF file
		formats, which means variable-width codes up to 12 bits and the first
		two non-literal codes are a clear code and an EOF code.

		The TIFF file format uses a similar but incompatible version of the LZW
		algorithm. See the golang.org/x/image/tiff/lzw package for an
		implementation.
	      writer.go
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Order int (basic type)
		Order specifies the bit ordering in an LZW data stream.

		As Inputs Of (at least 2)
			func NewReader(r io.Reader, order Order, litWidth int) io.ReadCloser
			func NewWriter(w io.Writer, order Order, litWidth int) io.WriteCloser
		As Types Of (total 2)
			const LSB
			const MSB


Package-Level Functions (total 2)

	 func NewReader(r io.Reader, order Order, litWidth int) io.ReadCloser
		NewReader creates a new io.ReadCloser.
		Reads from the returned io.ReadCloser read and decompress data from r.
		If r does not also 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
		finished reading.
		The number of bits to use for literal codes, litWidth, must be in the
		range [2,8] and is typically 8. It must equal the litWidth
		used during compression.

	 func NewWriter(w io.Writer, order Order, litWidth int) io.WriteCloser
		NewWriter creates a new io.WriteCloser.
		Writes to the returned io.WriteCloser are compressed and written to w.
		It is the caller's responsibility to call Close on the WriteCloser when
		finished writing.
		The number of bits to use for literal codes, litWidth, must be in the
		range [2,8] and is typically 8. Input bytes must be less than 1<<litWidth.


Package-Level Constants (total 2)

	const LSB Order = 0
		LSB means Least Significant Bits first, as used in the GIF file format.

	const MSB Order = 1
		MSB means Most Significant Bits first, as used in the TIFF and PDF
		file formats.

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.