archive

Documentation

Overview

Package archive expands zip, tar, gzip, and bzip2 payloads into leaf entries.

Index

• func LooksLikeArchive(data []byte) bool
• type Entry
  • func Walk(rootName string, data []byte, limits Limits) ([]Entry, error)
  • func WalkContext(ctx context.Context, rootName string, data []byte, limits Limits) ([]Entry, error)
• type Limits
• type PartialError
  • func (e *PartialError) Error() string
  • func (e *PartialError) Unwrap() error

Functions

func LooksLikeArchive

func LooksLikeArchive(data []byte) bool

Types

type Entry

type Entry struct {
	Path string
	Data []byte
}

Entry is one expanded file from inside an archive.

func Walk

func Walk(rootName string, data []byte, limits Limits) ([]Entry, error)

Walk expands data into a flat list of inner entries.

func WalkContext

func WalkContext(ctx context.Context, rootName string, data []byte, limits Limits) ([]Entry, error)

WalkContext is Walk with cancellation and deadline enforcement.

type Limits

type Limits struct {
	MaxDepth         int
	MaxEntryBytes    int64
	MaxExpandedBytes int64
	MaxFiles         int
}

Limits cap archive expansion work.

type PartialError

type PartialError struct {
	Kind, Entry string
	Err         error
}

PartialError identifies incomplete archive coverage while allowing callers to scan entries successfully extracted before or beside the failure.

func (*PartialError) Error

func (e *PartialError) Error() string

func (*PartialError) Unwrap

func (e *PartialError) Unwrap() error