pipe

Documentation

Overview

Package pipe implements walking a directory in a deterministic order.

Index

• func Split(inChan <-chan Job, dirChan chan<- Dir, entChan chan<- Entry)
• func Walk(ctx context.Context, walkPaths []string, selectFunc SelectFunc, ...)
• type Dir
  • func (e Dir) Error() error
  • func (e Dir) Fullpath() string
  • func (e Dir) Info() os.FileInfo
  • func (e Dir) Path() string
  • func (e Dir) Result() chan<- Result
• type Entry
  • func (e Entry) Error() error
  • func (e Entry) Fullpath() string
  • func (e Entry) Info() os.FileInfo
  • func (e Entry) Path() string
  • func (e Entry) Result() chan<- Result
• type Job
• type Result
• type SelectFunc

Functions

func Split

func Split(inChan <-chan Job, dirChan chan<- Dir, entChan chan<- Entry)

Split feeds all elements read from inChan to dirChan and entChan.

func Walk

func Walk(ctx context.Context, walkPaths []string, selectFunc SelectFunc, jobs chan<- Job, res chan<- Result)

Walk sends a Job for each file and directory it finds below the paths. When the channel done is closed, processing stops.

Types

type Dir

type Dir struct {
	Entries [](<-chan Result)
	// contains filtered or unexported fields
}

func (Dir) Error

func (e Dir) Error() error

func (Dir) Fullpath

func (e Dir) Fullpath() string

func (Dir) Info

func (e Dir) Info() os.FileInfo

func (Dir) Path

func (e Dir) Path() string

func (Dir) Result

func (e Dir) Result() chan<- Result

type Entry

type Entry struct {

	// points to the old node if available, interface{} is used to prevent
	// circular import
	Node interface{}
	// contains filtered or unexported fields
}

func (Entry) Error

func (e Entry) Error() error

func (Entry) Fullpath

func (e Entry) Fullpath() string

func (Entry) Info

func (e Entry) Info() os.FileInfo

func (Entry) Path

func (e Entry) Path() string

func (Entry) Result

func (e Entry) Result() chan<- Result

type Job

type Job interface {
	Path() string
	Fullpath() string
	Error() error
	Info() os.FileInfo

	Result() chan<- Result
}

type Result

type Result interface{}

type SelectFunc

type SelectFunc func(item string, fi os.FileInfo) bool

SelectFunc returns true for all items that should be included (files and dirs). If false is returned, files are ignored and dirs are not even walked.