walk

Documentation

Index

• type Action
• type Builder
  • func From(dir string) Builder
• type Dirent
• type Predicate

Types

type Action

type Action func(path string, info Dirent) error

Action is a function that takes a file's path and information, and optionally returns an error.

type Builder

type Builder interface {
	// Unsorted Options
	Unsorted() Builder

	// When Predicates
	When(Predicate) Builder
	WhenIsDir() Builder
	WhenIsFile() Builder
	WhenHasName(string) Builder
	WhenNameMatches(string) Builder

	// Do Actions
	Do(Action) error
	MustDo(Action)
	AppendPaths(*[]string) error
	CollectPaths() ([]string, error)
	CollectFilterPaths(...string) ([]string, error)
	CollectPathsGrouped(depth int) (map[string][]string, error)
	CollectDepthPaths(depth int) ([]string, error)
}

func From

func From(dir string) Builder

type Dirent

type Dirent interface {
	IsDir() bool
	Name() string
}

Dirent stores the name and type of a file system entry.

type Predicate

type Predicate func(path string, info Dirent) (bool, error)

Predicate represents a predicate on file system entries. Given a file's path and information, it returns `true` when the predicate is matched. It can also return a `filepath.SkipDir` error to skip a directory and its children altogether.