extract

Documentation

Overview

Package extract unpacks tar archives (optionally xz- or gzip-compressed) and writes each regular file into a destination directory, optionally recompressing members with gzip or xz. Member paths are validated against directory traversal.

Index

• func IsArchive(name string) bool
• type Result
  • func Archive(archivePath, destDir, comp string) (Result, error)

Functions

func IsArchive

func IsArchive(name string) bool

IsArchive reports whether name looks like a tar archive this package can extract: .tar, .tar.gz, .tgz, or .tar.xz.

Types

type Result

type Result struct {
	Files int   // regular files written
	Bytes int64 // total bytes written to disk (post-recompression)
}

Result summarises a single archive extraction.

func Archive

func Archive(archivePath, destDir, comp string) (Result, error)

Archive extracts every regular file from archivePath into destDir, recompressing each member according to comp ("none", "gz", or "xz"). The outer compression is detected from archivePath's extension.