dig

Documentation

Index

• type Digger
  • func New() Digger
• type FileInfo
• type FileInfoHandler
• type Instr
  • func (i Instr) String() string

Types

type Digger

type Digger interface {
	// Dig searches the information of a file or a directory recursively.
	Dig(name string, handler FileInfoHandler) error
}

Digger provides recursive file search operations.

func New

func New() Digger

New returns a new Digger.

type FileInfo

type FileInfo interface {
	Name() string
	Size() int64
	Mode() fs.FileMode
	ModTime() time.Time
	IsDir() bool
}

type FileInfoHandler

type FileInfoHandler func(FileInfo) Instr

type Instr

type Instr int

const (
	// InstrCancel cancels the invocation of Dig.
	InstrCancel Instr = iota
	// InstrSkipDir skips digging the children of the directory.
	InstrSkipDir
	// InstrContinue digs the children of the directory recursively.
	InstrContinue
)

func (Instr) String

func (i Instr) String() string