Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

archive

package module

Go to main page

Versions in this module

v0

v0.3.0

Nov 8, 2026

Changes in this version

+ func Clean(name string) string

v0.2.2

Nov 7, 2026

v0.2.1

Nov 7, 2026

Changes in this version

type ListerOptions

+ MaxEntries int

v0.2.0

Oct 29, 2026

Changes in this version

+ func Extensions() []string

+ func ExtractFunc(src Source, size int64, baseName string, opts Options, ...) (err error)

+ func ExtractReader(r io.Reader, baseName string, dest *os.Root, opts Options) (err error)

+ func HasExtension(name string) bool

+ func IsMediaType(contentType string) bool

+ func IsStream(name string) bool

+ func StripExtension(name string) string

type Options

+ CaseSensitive bool

v0.1.1

Oct 29, 2026

v0.1.0

Oct 29, 2026

Changes in this version

+ const DefaultMaxEntries

+ const DefaultMaxEntryBytes

+ const DefaultMaxRatio

+ const DefaultMaxTotalBytes

+ const DefaultRatioFloor

+ var ErrArchiveTooLarge = errors.New("archive exceeds the extracted size cap")

+ var ErrCaseCollision = errors.New("name collides with another entry")

+ var ErrChecksum = errors.New("checksum mismatch")

+ var ErrDecoderMemory = errors.New("decoder memory exceeds the extraction cap")

+ var ErrEncrypted = errors.New("archive is encrypted")

+ var ErrEntryTooLarge = errors.New("entry exceeds the size cap")

+ var ErrLink = errors.New("symlinks and hardlinks are not allowed")

+ var ErrMalformed = errors.New("archive is malformed")

+ var ErrRatio = errors.New("archive unpacks to far more than its size allows")

+ var ErrSpecialFile = errors.New("device, pipe and socket entries are not allowed")

+ var ErrTooManyEntries = errors.New("archive exceeds the entry cap")

+ var ErrTraversal = errors.New("path escapes the destination")

+ var ErrUnsafeName = errors.New("name is not allowed")

+ var ErrUnsupportedFormat = errors.New("not a zip, RAR, 7z, tar, gzip, xz, lzma, zstd, bzip2 or lz4 archive")

+ func DeclaredSize(src Source, size int64) (_ int64, err error)

+ func Extract(src Source, size int64, baseName string, dest *os.Root, opts Options) (err error)

+ func RecoverMalformed(err *error)

+ func WindowsSegment(seg string) bool

+ type Entry struct

+ IsDir bool

+ Name string

+ Size int64

+ type Error struct

+ Entry string

+ Reason error

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type Lister struct

+ func NewLister(src Source, size int64, baseName string, opts ListerOptions) (*Lister, error)

+ func (l *Lister) Close() error

+ func (l *Lister) Entries() iter.Seq2[Entry, error]

+ func (l *Lister) Next() (Entry, error)

+ func (l *Lister) Open() (_ io.ReadCloser, err error)

+ type ListerOptions struct

+ MaxEntryBytes int64

+ type Options struct

+ MaxEntries int

+ MaxEntryBytes int64

+ MaxRatio int64

+ MaxTotalBytes int64

+ RatioFloor int64

+ Segment func(seg string) bool

+ type Source interface