package zip

Import Path
	archive/zip (on golang.org and go.dev)

Dependency Relation
	imports 14 packages, and imported by 0 packages

Involved Source Files
	    reader.go
	    register.go
	d-> struct.go
	    writer.go

Exported Type Names

	 type Compressor (func)
		A Compressor returns a new compressing writer, writing to w.
		The WriteCloser's Close method must be used to flush pending data to w.
		The Compressor itself must be safe to invoke from multiple goroutines
		simultaneously, but each returned writer will be used only by
		one goroutine at a time.

		As Inputs Of (2+)
			func RegisterCompressor(method uint16, comp Compressor)
			func (*Writer).RegisterCompressor(method uint16, comp Compressor)
	 type Decompressor (func)
		A Decompressor returns a new decompressing reader, reading from r.
		The ReadCloser's Close method must be used to release associated resources.
		The Decompressor itself must be safe to invoke from multiple goroutines
		simultaneously, but each returned reader will be used only by
		one goroutine at a time.

		As Inputs Of (2+)
			func RegisterDecompressor(method uint16, dcomp Decompressor)
			func (*Reader).RegisterDecompressor(method uint16, dcomp Decompressor)
	 type File (struct)

		Exported Fields (18)
			FileHeader FileHeader
			FileHeader.CRC32 uint32
			FileHeader.Comment string
			FileHeader.CompressedSize uint32
			FileHeader.CompressedSize64 uint64
			FileHeader.CreatorVersion uint16
			FileHeader.ExternalAttrs uint32
			FileHeader.Extra []byte
			FileHeader.Flags uint16
			FileHeader.Method uint16
			FileHeader.Modified time.Time
			FileHeader.ModifiedDate uint16
			FileHeader.ModifiedTime uint16
			FileHeader.Name string
			FileHeader.NonUTF8 bool
			FileHeader.ReaderVersion uint16
			FileHeader.UncompressedSize uint32
			FileHeader.UncompressedSize64 uint64
		Exported Methods (7)
			(*T) DataOffset() (offset int64, err error)
			(*T) FileInfo() os.FileInfo
			(*T) ModTime() time.Time
			(*T) Mode() (mode os.FileMode)
			(*T) Open() (io.ReadCloser, error)
			(*T) SetModTime(t time.Time)
			(*T) SetMode(mode os.FileMode)
	 type FileHeader (struct)
		FileHeader describes a file within a zip file.
		See the zip spec for details.

		Exported Fields (17)
			CRC32 uint32
			Comment string
			CompressedSize uint32
			CompressedSize64 uint64
			CreatorVersion uint16
			ExternalAttrs uint32
			Extra []byte
			Flags uint16
			Method uint16
			Modified time.Time
			ModifiedDate uint16
			ModifiedTime uint16
			Name string
			NonUTF8 bool
			ReaderVersion uint16
			UncompressedSize uint32
			UncompressedSize64 uint64
		Exported Methods (5)
			(*T) FileInfo() os.FileInfo
			(*T) ModTime() time.Time
			(*T) Mode() (mode os.FileMode)
			(*T) SetModTime(t time.Time)
			(*T) SetMode(mode os.FileMode)
		As Outputs Of (1+)
			func FileInfoHeader(fi os.FileInfo) (*FileHeader, error)
		As Inputs Of (1+)
			func (*Writer).CreateHeader(fh *FileHeader) (io.Writer, error)
	 type ReadCloser (struct)

		Exported Fields (3)
			Reader Reader
			Reader.Comment string
			Reader.File []*File
		Exported Methods (2)
			(*T) Close() error
			(*T) RegisterDecompressor(method uint16, dcomp Decompressor)
		Implements (1+)
			*T : io.Closer
		As Outputs Of (1+)
			func OpenReader(name string) (*ReadCloser, error)
	 type Reader (struct)

		Exported Fields (2)
			Comment string
			File []*File
		One Exported Method
			(*T) RegisterDecompressor(method uint16, dcomp Decompressor)
		As Outputs Of (1+)
			func NewReader(r io.ReaderAt, size int64) (*Reader, error)
	 type Writer (struct)
		Writer implements a zip file writer.

		Exported Methods (7)
			(*T) Close() error
			(*T) Create(name string) (io.Writer, error)
			(*T) CreateHeader(fh *FileHeader) (io.Writer, error)
			(*T) Flush() error
			(*T) RegisterCompressor(method uint16, comp Compressor)
			(*T) SetComment(comment string) error
			(*T) SetOffset(n int64)
		Implements (1+)
			*T : io.Closer
		As Outputs Of (1+)
			func NewWriter(w io.Writer) *Writer
Exported Values

	const Deflate uint16 = 8 // DEFLATE compressed
		Compression methods.
	  var ErrAlgorithm error
	  var ErrChecksum error
	  var ErrFormat error
	 func FileInfoHeader(fi os.FileInfo) (*FileHeader, error)
		FileInfoHeader creates a partially-populated FileHeader from an
		os.FileInfo.
		Because os.FileInfo's Name method returns only the base name of
		the file it describes, it may be necessary to modify the Name field
		of the returned header to provide the full path name of the file.
		If compression is desired, callers should set the FileHeader.Method
		field; it is unset by default.
	 func NewReader(r io.ReaderAt, size int64) (*Reader, error)
		NewReader returns a new Reader reading from r, which is assumed to
		have the given size in bytes.
	 func NewWriter(w io.Writer) *Writer
		NewWriter returns a new Writer writing a zip file to w.
	 func OpenReader(name string) (*ReadCloser, error)
		OpenReader will open the Zip file specified by name and return a ReadCloser.
	 func RegisterCompressor(method uint16, comp Compressor)
		RegisterCompressor registers custom compressors for a specified method ID.
		The common methods Store and Deflate are built in.
	 func RegisterDecompressor(method uint16, dcomp Decompressor)
		RegisterDecompressor allows custom decompressors for a specified method ID.
		The common methods Store and Deflate are built in.
	const Store uint16 = 0 // no compression
		Compression methods.

The pages are generated with Golds v0.1.6-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project and 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.