tar

Documentation

Index

• type TarGz
  • func (tg *TarGz) Create(buf io.Writer, options *TarGzOptions, src []string, ignore ...string) error
  • func (tg *TarGz) Extract(src io.Reader, gziped bool, dst string) error
• type TarGzOptions

Types

type TarGz

type TarGz struct {
}

func (*TarGz) Create

func (tg *TarGz) Create(buf io.Writer, options *TarGzOptions, src []string, ignore ...string) error

Compress compresses the src directory into a tar.gz file optionally a list of globs to be ignored can be passed

func (*TarGz) Extract

func (tg *TarGz) Extract(src io.Reader, gziped bool, dst string) error

type TarGzOptions

type TarGzOptions struct {
	// OmitRoot when set to true ignores the top level directory in the tar archive
	// only adding sub directories and files.
	// /folder/foo/bar/test.txt -> /test.txt
	// /folder/foo/bar/baz/* -> /baz
	OmitRoot bool

	// ZipContents controlls if the contents of the tar is compressed
	ZipContents bool

	// StripFolder is like OmitRoot except all folder are removed and the file list is
	// flattened. Duplicate filenames will be overwritten
	StripFolders bool
}