ant

Documentation

Overview

Package ant walks source trees and applies an action function to matching files.

It supports optional file filtering, exclusion lists, and parallel execution of per-file processing callbacks.

Index

• type Admin
  • func (p *Admin) Walk(w io.Writer, fSys *afero.Afero) error
• type Processing

Types

type Admin

type Admin struct {
	Trees            []string                  // Trees contains all files and folders to process. Sub-folders are walked automatically.
	ExcludeTrees     []string                  // ExcludeTrees contains file and folder paths to be excluded from processing during the Walk operation.
	Verbose          bool                      // Verbose enables or disables detailed logging during processing.
	MatchingFileName func(fi os.FileInfo) bool // MatchingFileName is a user provided function and returns true on matching user conditions. Simplest case: func(_ os.FileInfo){ return true } for all files.
	Action           Processing                // Action is the user provided function executed on each file in Trees.
	Mutex            sync.RWMutex              // A sync.RWMutex is thus preferable for data that is mostly read.
	// contains filtered or unexported fields
}

Admin holds the walk specific data.

func (*Admin) Walk

func (p *Admin) Walk(w io.Writer, fSys *afero.Afero) error

Walk performs p.action on each file in passed srcs and all sub trees.

type Processing

type Processing func(w io.Writer, fSys *afero.Afero, path string, fileInfo os.FileInfo, p *Admin) error

Processing is a function type, executed for each file inside the visit function.