archive

Documentation

Index

• Constants
• Variables
• type Config
• type ExtractActivity
  • func NewExtractActivity(cfg Config) *ExtractActivity
  • func (a *ExtractActivity) Execute(ctx context.Context, params *ExtractActivityParams) (*ExtractActivityResult, error)
• type ExtractActivityParams
• type ExtractActivityResult

Constants

const ExtractActivityName = "extract-archive-activity"

Variables

var (
	ErrNotAFile       = errors.New("Not a file")
	ErrInvalidArchive = errors.New("Invalid archive")
)

Types

type Config

type Config struct {
	DirMode  fs.FileMode
	FileMode fs.FileMode
}

type ExtractActivity

type ExtractActivity struct {
	// contains filtered or unexported fields
}

func NewExtractActivity

func NewExtractActivity(cfg Config) *ExtractActivity

func (*ExtractActivity) Execute

func (a *ExtractActivity) Execute(
	ctx context.Context, params *ExtractActivityParams,
) (*ExtractActivityResult, error)

Execute extracts the content of SourcePath to a unique extract directory in DestPath then returns the ExtractPath.

If SourcePath is a directory an ErrNotAFile error is returned. If SourcePath is a file, but not a valid archive, an ErrInvalidArchive error is returned.

type ExtractActivityParams

type ExtractActivityParams struct {
	// SourcePath is the path of the archive to be extracted.
	SourcePath string

	// DestPath is the path where the ExtractPath should be created. If
	// DestPath is not set then ExtractPath will be in the same directory as
	// SourcePath.
	DestPath string
}

type ExtractActivityResult

type ExtractActivityResult struct {
	// ExtractPath is the path of the extracted archive contents.
	ExtractPath string
}