cwalk

Documentation

Index

• Variables
• func WalkDir(root string, walkFn fs.WalkDirFunc) error
• type Walker
  • func (w *Walker) Walk(relpath string, walkFn fs.WalkDirFunc) error
• type WalkerError
  • func (we WalkerError) Error() string
• type WalkerErrorList
  • func (wel WalkerErrorList) Error() string

Variables

var BufferSize = NumWorkers

BufferSize defines the size of the job buffer

var ErrNotDir = errors.New("Not a directory")

ErrNotDir indicates that the path, which is being passed to a walker function, does not point to a directory

var NumWorkers = runtime.NumCPU() * 2

NumWorkers defines how many workers to run on each Walk() function invocation

Functions

func WalkDir

func WalkDir(root string, walkFn fs.WalkDirFunc) error

Types

type Walker

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

Walker is constructed for each Walk() function invocation

func (*Walker) Walk

func (w *Walker) Walk(relpath string, walkFn fs.WalkDirFunc) error

Walk recursively descends into subdirectories, calling walkFn for each file or directory in the tree, including the root directory.

type WalkerError

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

WalkerError struct stores individual errors reported from each worker routine

func (WalkerError) Error

func (we WalkerError) Error() string

Implement the error interface for WalkerError

type WalkerErrorList

type WalkerErrorList struct {
	ErrorList []WalkerError
}

WalkerErrorList struct store a list of errors reported from all worker routines

func (WalkerErrorList) Error

func (wel WalkerErrorList) Error() string

Implement the error interface fo WalkerErrorList