archive

Documentation

Index

• Variables
• func Pack(w io.Writer, format Format, files ...File) error
• func PackFromFiles(w io.Writer, format Format, files ...string) error
• func UnpackToFiles(r io.Reader, dest string) error
• type File
  • func Unpack(r io.Reader) ([]File, error)
• type Format
  • func IsArchive(b []byte) (bool, Format)

Variables

var ErrFormat = errors.New("unknown format")

ErrFormat indicates that encountered an unknown format.

Functions

func Pack

func Pack(w io.Writer, format Format, files ...File) error

Pack creates an archive from File struct.

func PackFromFiles

func PackFromFiles(w io.Writer, format Format, files ...string) error

PackFromFiles creates an archive from files.

func UnpackToFiles

func UnpackToFiles(r io.Reader, dest string) error

UnpackToFiles decompresses an archive to files.

Types

type File

type File struct {
	Name  string
	Body  []byte
	IsDir bool
}

File struct contains bytes body and the provided name field.

func Unpack

func Unpack(r io.Reader) ([]File, error)

Unpack decompresses an archive to File struct.

type Format

type Format int

Format represents the archive format.

const (
	// ZIP format
	ZIP Format = iota
	// TAR format
	TAR
)

func IsArchive

func IsArchive(b []byte) (bool, Format)

IsArchive tests b is an archive file or not, if ok also return its format.