walk

Documentation

Index

• Variables
• func Walk(root string, walkFn WalkFn) error
• func WalkRoots(roots []string, walkFn WalkFn) error
• type WalkFn

Variables

var TraverseLink = errors.New("traverse symlink, assuming target is a directory")

TraverseLink is a sentinel error for Walk, similar to filepath.SkipDir.

Functions

func Walk

func Walk(root string, walkFn WalkFn) error

Walk walks the file tree rooted at root, calling walkFn for each file or directory in the tree, including root.

If Walk returns filepath.SkipDir, the directory is skipped.

Unlike filepath.Walk:

• file stat calls must be done by the user. The only provided metadata is the file type, which does not include any permission bits.
• multiple goroutines stat the filesystem concurrently. The provided walkFn must be safe for concurrent use.
• Walk can follow symlinks if walkFn returns the TraverseLink sentinel error. It is the walkFn's responsibility to prevent Walk from going into symlink cycles.

func WalkRoots

func WalkRoots(roots []string, walkFn WalkFn) error

Types

type WalkFn

type WalkFn func(path string, typ os.FileMode, rc io.ReadCloser) error