zip

Documentation

Overview

Package zip implements zip repository importer.

Index

• Constants
• type Archive
  • func (a *Archive) Description() string
  • func (a *Archive) ID() string
  • func (a *Archive) LocalPath() string
  • func (a *Archive) Preprocess() (string, error)
  • func (a *Archive) QuickSHA256Hash() (string, error)
  • func (a *Archive) RemotePath() string
  • func (a *Archive) RepoName() string
  • func (a *Archive) RepoPath() string
• type Repo
  • func NewRepo(path string, fileExtensions string) *Repo
  • func (r *Repo) DiscoverRepo() ([]hashr.Source, error)
  • func (r *Repo) RepoName() string
  • func (r *Repo) RepoPath() string

Constants

const (
	// RepoName contains the repository name.
	RepoName = "zip"
)

Types

type Archive

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

Archive holds data related to zip archive.

func (*Archive) Description

func (a *Archive) Description() string

Description provides additional description for a .zip file.

func (*Archive) ID

func (a *Archive) ID() string

ID returns non-unique zip Archive ID.

func (*Archive) LocalPath

func (a *Archive) LocalPath() string

LocalPath returns local path to a zip Archive .zip file.

func (*Archive) Preprocess

func (a *Archive) Preprocess() (string, error)

Preprocess extracts the contents of a .zip file.

func (*Archive) QuickSHA256Hash

func (a *Archive) QuickSHA256Hash() (string, error)

QuickSHA256Hash calculates sha256 hash of .zip file.

func (*Archive) RemotePath

func (a *Archive) RemotePath() string

RemotePath returns non-local path to a zip Archive .zip file.

func (*Archive) RepoName

func (a *Archive) RepoName() string

RepoName returns repository name.

func (*Archive) RepoPath

func (a *Archive) RepoPath() string

RepoPath returns repository path.

type Repo

type Repo struct {
	Archives []*Archive
	// contains filtered or unexported fields
}

Repo holds data related to a zip repository.

func NewRepo

func NewRepo(path string, fileExtensions string) *Repo

NewRepo returns new instance of zip repository.

func (*Repo) DiscoverRepo

func (r *Repo) DiscoverRepo() ([]hashr.Source, error)

DiscoverRepo traverses the repository and looks for files that are related to zip base Archives.

func (*Repo) RepoName

func (r *Repo) RepoName() string

RepoName returns repository name.

func (*Repo) RepoPath

func (r *Repo) RepoPath() string

RepoPath returns repository path.