tar

Documentation

Index

• type Extractor
  • func (te *Extractor) Extract(reader io.Reader) error
  • func (te *Extractor) Sanitize(toggle bool)
• type Link

Types

type Extractor

type Extractor struct {
	Path     string
	Progress func(int64) int64

	// SanitizePathFunc can be provided if you wish to inspect and/or modify the source path
	// returning an error from this function will abort extraction
	SanitizePathFunc func(path string) (saferPath string, userDefined error)

	// LinkFunc can be provided for user specified handling of filesystem links
	// returning an error from this function aborts extraction
	LinkFunc func(Link) error
}

func (*Extractor) Extract

func (te *Extractor) Extract(reader io.Reader) error

func (*Extractor) Sanitize

func (te *Extractor) Sanitize(toggle bool)

Sanitize sets up the extractor to use built in sanitation functions (Modify paths to be platform legal, symlinks may not escape extraction root) or unsets any previously set sanitation functions on the extractor (no special rules are applied when extracting)

type Link

type Link struct {
	Root, Name, Target string
}

Link represents a filesystem link where Name is the link's destination path, Target is what the link actually points to, and Root is the extraction root