Package: archive/zip

package zip Import Path archive/zip (on golang.org and go.dev) Dependency Relation imports 15 packages, and imported by 0 packages

Involved Source Files reader.go register.go d➜ struct.go Package zip provides support for reading and writing ZIP archives. See: https://www.pkware.com/appnote This package does not support disk spanning. A note about ZIP64: To be backwards compatible the FileHeader has both 32 and 64 bit Size fields. The 64 bit fields will always contain the correct value and for normal archives both fields will be the same. For files requiring the ZIP64 format the 32 bit fields will be 0xffffffff and the 64 bit fields must be used instead. writer.go

Code Examples Reader package main import ( "archive/zip" "fmt" "io" "log" "os" ) func main() { // Open a zip archive for reading. r, err := zip.OpenReader("testdata/readme.zip") if err != nil { log.Fatal(err) } defer r.Close() // Iterate through the files in the archive, // printing some of their contents. for _, f := range r.File { fmt.Printf("Contents of %s:\n", f.Name) rc, err := f.Open() if err != nil { log.Fatal(err) } _, err = io.CopyN(os.Stdout, rc, 68) if err != nil { log.Fatal(err) } rc.Close() fmt.Println() } } Writer package main import ( "archive/zip" "bytes" "log" ) func main() { // Create a buffer to write our archive to. buf := new(bytes.Buffer) // Create a new zip archive. w := zip.NewWriter(buf) // Add some files to the archive. var files = []struct { Name, Body string }{ {"readme.txt", "This archive contains some text files."}, {"gopher.txt", "Gopher names:\nGeorge\nGeoffrey\nGonzo"}, {"todo.txt", "Get animal handling licence.\nWrite more examples."}, } for _, file := range files { f, err := w.Create(file.Name) if err != nil { log.Fatal(err) } _, err = f.Write([]byte(file.Body)) if err != nil { log.Fatal(err) } } // Make sure to check the error on Close. err := w.Close() if err != nil { log.Fatal(err) } } Writer_RegisterCompressor package main import ( "archive/zip" "bytes" "compress/flate" "io" ) func main() { // Override the default Deflate compressor with a higher compression level. // Create a buffer to write our archive to. buf := new(bytes.Buffer) // Create a new zip archive. w := zip.NewWriter(buf) // Register a custom Deflate compressor. w.RegisterCompressor(zip.Deflate, func(out io.Writer) (io.WriteCloser, error) { return flate.NewWriter(out, flate.BestCompression) }) // Proceed to add files to w. }

Package-Level Functions (total 6)

func FileInfoHeader(fi fs.FileInfo) (*FileHeader, error) FileInfoHeader creates a partially-populated FileHeader from an fs.FileInfo. Because fs.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.

Package-Level Variables (total 3)

var ErrAlgorithm error

var ErrChecksum error

var ErrFormat error

Package-Level Constants (total 2)

const Deflate uint16 = 8 // DEFLATE compressed Compression methods.

const Store uint16 = 0 // no compression Compression methods.