files

Documentation

Index

• Constants
• func DeleteFile(filePath string) error
• func GetFileInfo(filePath string) (os.FileInfo, error)
• func GzipDecompressFile(filePath, outputPath string) error
• func GzipFile(filePath, outputPath string) error
• func ReadFileBytes(filePath string) ([]byte, error)
• type File
• type ScanResult
• type Scanner
  • func NewScanner(fileRegexp string, minFileSize int64) *Scanner
  • func (s *Scanner) Scan(directoryRoot string) (*ScanResult, error)

Constants

const GZExtension = ".gz"

GZExtension - gz extension

Functions

func DeleteFile

func DeleteFile(filePath string) error

DeleteFile - deletes a file

func GetFileInfo

func GetFileInfo(filePath string) (os.FileInfo, error)

GetFileInfo - returns the file info

func GzipDecompressFile

func GzipDecompressFile(filePath, outputPath string) error

GzipDecompressFile - ungzips a file

func GzipFile

func GzipFile(filePath, outputPath string) error

GzipFile - gzips a file

func ReadFileBytes

func ReadFileBytes(filePath string) ([]byte, error)

ReadFileBytes - read all specified file bytes

Types

type File

type File struct {
	Name             string
	Path             string
	Size             int64
	LastModification time.Time
	Ignored          bool
}

File - has some basic information about the file

type ScanResult

type ScanResult struct {
	Files   []*File
	Ignored []*File
	Errors  []error
}

ScanResult - has all files and errors found when traversing the files in root directory

type Scanner

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

Scanner - Scans a directory and find files using regular expression

func NewScanner

func NewScanner(fileRegexp string, minFileSize int64) *Scanner

NewScanner - builds a new Scanner

func (*Scanner) Scan

func (s *Scanner) Scan(directoryRoot string) (*ScanResult, error)

Scan - searches recursively for files with the same regexp pattern selected