file

package

v1.3.0 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/anchore/syft

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
func CleanDigestAlgorithmName(name string) string
func ContentsFromZip(archivePath string, paths ...string) (map[string]string, error)
func ExtractFromZipToUniqueTempFile(archivePath, dir string, paths ...string) (map[string]Opener, error)
func ExtractGlobsFromTarToUniqueTempFile(archivePath, dir string, globs ...string) (map[string]Opener, error)
func GlobMatch(pattern, name string) bool
func Hashers(names ...string) ([]crypto.Hash, error)
func NewDigestsFromFile(closer io.ReadCloser, hashes []crypto.Hash) ([]file.Digest, error)
func NormalizeHashes(hashes []crypto.Hash) []crypto.Hash
func TraverseFilesInZip(archivePath string, visitor func(*zip.File) error, paths ...string) error
func UnzipToDir(archivePath, targetDir string) error
type Opener
- func (o Opener) Open() (io.ReadCloser, error)
type ZipFileManifest
- func NewZipFileManifest(archivePath string) (ZipFileManifest, error)
- func (z ZipFileManifest) Add(entry string, info os.FileInfo)
- func (z ZipFileManifest) GlobMatch(caseInsensitive bool, patterns ...string) []string
type ZipReadCloser
- func OpenZip(filepath string) (*ZipReadCloser, error)

Constants ¶

View Source

const (
	KB = 1 << (10 * iota)
	MB
	GB
)

Variables ¶

This section is empty.

Functions ¶

func CleanDigestAlgorithmName ¶ added in v0.85.0

func CleanDigestAlgorithmName(name string) string

func ContentsFromZip ¶

func ContentsFromZip(archivePath string, paths ...string) (map[string]string, error)

ContentsFromZip extracts select paths for the given archive and returns a set of string contents for each path.

func ExtractFromZipToUniqueTempFile ¶

func ExtractFromZipToUniqueTempFile(archivePath, dir string, paths ...string) (map[string]Opener, error)

ExtractFromZipToUniqueTempFile extracts select paths for the given archive to a temporary directory, returning file openers for each file extracted.

func ExtractGlobsFromTarToUniqueTempFile ¶ added in v0.35.0

func ExtractGlobsFromTarToUniqueTempFile(archivePath, dir string, globs ...string) (map[string]Opener, error)

ExtractGlobsFromTarToUniqueTempFile extracts paths matching the given globs within the given archive to a temporary directory, returning file openers for each file extracted.

func GlobMatch ¶

func GlobMatch(pattern, name string) bool

GlobMatch evaluates the given glob pattern against the given "name" string, indicating if there is a match or not. Source: https://research.swtch.com/glob.go

func Hashers ¶ added in v0.85.0

func Hashers(names ...string) ([]crypto.Hash, error)

func NewDigestsFromFile ¶ added in v0.85.0

func NewDigestsFromFile(closer io.ReadCloser, hashes []crypto.Hash) ([]file.Digest, error)

func NormalizeHashes ¶ added in v0.101.1

func NormalizeHashes(hashes []crypto.Hash) []crypto.Hash

func TraverseFilesInZip ¶

func TraverseFilesInZip(archivePath string, visitor func(*zip.File) error, paths ...string) error

TraverseFilesInZip enumerates all paths stored within a zip archive using the visitor pattern.

func UnzipToDir ¶

func UnzipToDir(archivePath, targetDir string) error

UnzipToDir extracts a zip archive to a target directory.

Types ¶

type Opener ¶ added in v0.4.0

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

Opener is an object that stores a path to later be opened as a file.

func (Opener) Open ¶ added in v0.4.0

func (o Opener) Open() (io.ReadCloser, error)

Open the stored path as a io.ReadCloser.

type ZipFileManifest ¶

type ZipFileManifest map[string]os.FileInfo

ZipFileManifest is a collection of paths and their file metadata.

func NewZipFileManifest ¶

func NewZipFileManifest(archivePath string) (ZipFileManifest, error)

NewZipFileManifest creates and returns a new ZipFileManifest populated with path and metadata from the given zip archive path.

func (ZipFileManifest) Add ¶

func (z ZipFileManifest) Add(entry string, info os.FileInfo)

Add a new path and it's file metadata to the collection.

func (ZipFileManifest) GlobMatch ¶

func (z ZipFileManifest) GlobMatch(caseInsensitive bool, patterns ...string) []string

GlobMatch returns the path keys that match the given value(s).

type ZipReadCloser ¶ added in v0.17.0

type ZipReadCloser struct {
	*zip.Reader
	io.Closer
}

ZipReadCloser is a drop-in replacement for zip.ReadCloser (from zip.OpenReader) that additionally considers zips that have bytes prefixed to the front of the archive (common with self-extracting jars).

func OpenZip ¶ added in v0.17.0

func OpenZip(filepath string) (*ZipReadCloser, error)

OpenZip provides a ZipReadCloser for the given filepath.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL