archive

Documentation

Overview

Package archive GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

• type Tar
  • func (t *Tar) Do(ctx context.Context) error
  • func (v Tar) RuntimeDoc(names ...string) ([]string, bool)
• type UnTar
  • func (t *UnTar) Do(ctx context.Context) error
  • func (v UnTar) RuntimeDoc(names ...string) ([]string, bool)

Types

type Tar

type Tar struct {
	task.Task
	// specified dir for tar
	SrcDir wd.WorkDir `json:"srcDir"`
	// tar out filename base on the current work dir
	OutFile file.File `json:"outFile"`
	// created tarfile
	File file.File `json:"-" output:"file"`
}

Tar make a tar archive file of specified dir

func (*Tar) Do

func (t *Tar) Do(ctx context.Context) error

func (Tar) RuntimeDoc

func (v Tar) RuntimeDoc(names ...string) ([]string, bool)

type UnTar

type UnTar struct {
	task.Task

	// tar filename base on the current work outDir
	SrcFile file.File `json:"srcFile"`
	// tar file content encoding
	ContentEncoding string `json:"contentEncoding,omitempty"`
	// output outDir for tar
	OutDir wd.WorkDir `json:"outDir"`
	// final dir contains tar files
	Dir wd.WorkDir `json:"-" output:"dir"`
}

UnTar un tar files into specified outDir

func (*UnTar) Do

func (t *UnTar) Do(ctx context.Context) error

func (UnTar) RuntimeDoc

func (v UnTar) RuntimeDoc(names ...string) ([]string, bool)