digestnamed

Documentation

Index

• type Report
• type Scanner
  • func NewScanner(skipPatterns []string) (Scanner, error)
  • func (s Scanner) ScanDirectory(path string) (Report, error)

Types

type Report

type Report struct {
	// Passed files contain their digest in the filename
	Passed []string

	// Skipped files weren't checked because they matched an allowed pattern
	Skipped []string

	// Failed files don't contain a matching digest in the filename
	Failed []string

	// NonRegular files cannot be checked because opening them is probably unsafe
	NonRegular []string

	FileErrors map[string]error
}

type Scanner

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

func NewScanner

func NewScanner(skipPatterns []string) (Scanner, error)

func (Scanner) ScanDirectory

func (s Scanner) ScanDirectory(path string) (Report, error)

ScanDirectory checks that the files in a directory and its children are named based on their digest contents. This only returns an error if there was a problem traversing the directory and its children; any errors opening/reading files are reported in the Report instead.