watch

Documentation

Index

• type EmptyMatcher
  • func (EmptyMatcher) Matches(f string) (bool, error)
  • func (EmptyMatcher) MatchesEntireDir(f string) (bool, error)
• type FileEvent
  • func NewFileEvent(p string) FileEvent
  • func (e FileEvent) Path() string
• type Notify
  • func NewWatcher(paths []string, ignore PathMatcher, l logger.Logger) (Notify, error)
• type PathMatcher
• type TempDir
  • func NewDir(prefix string) (*TempDir, error)
  • func NewDirAtRoot(root, prefix string) (*TempDir, error)
  • func NewDirAtSlashTmp(prefix string) (*TempDir, error)
  • func (d *TempDir) NewDeterministicDir(name string) (*TempDir, error)
  • func (d *TempDir) NewDir(prefix string) (*TempDir, error)
  • func (d *TempDir) Path() string
  • func (d *TempDir) TearDown() error

Types

type EmptyMatcher

type EmptyMatcher struct {
}

func (EmptyMatcher) Matches

func (EmptyMatcher) Matches(f string) (bool, error)

func (EmptyMatcher) MatchesEntireDir

func (EmptyMatcher) MatchesEntireDir(f string) (bool, error)

type FileEvent

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

func NewFileEvent

func NewFileEvent(p string) FileEvent

func (FileEvent) Path

func (e FileEvent) Path() string

type Notify

type Notify interface {
	// Start watching the paths set at init time
	Start() error

	// Stop watching and close all channels
	Close() error

	// A channel to read off incoming file changes
	Events() chan FileEvent

	// A channel to read off show-stopping errors
	Errors() chan error
}

func NewWatcher

func NewWatcher(paths []string, ignore PathMatcher, l logger.Logger) (Notify, error)

type PathMatcher

type PathMatcher interface {
	Matches(file string) (bool, error)

	// If this matches the entire dir, we can often optimize filetree walks a bit.
	MatchesEntireDir(file string) (bool, error)
}

When we specify directories to watch, we often want to ignore some subset of the files under those directories.

For example: - Watch /src/repo, but ignore /src/repo/.git - Watch /src/repo, but ignore everything in /src/repo/bazel-bin except /src/repo/bazel-bin/app-binary

The PathMatcher inteface helps us manage these ignores.

type TempDir

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

TempDir holds a temp directory and allows easy access to new temp directories.

func NewDir

func NewDir(prefix string) (*TempDir, error)

NewDir creates a new TempDir in the default location (typically $TMPDIR)

func NewDirAtRoot

func NewDirAtRoot(root, prefix string) (*TempDir, error)

NewDir creates a new TempDir at the given root.

func NewDirAtSlashTmp

func NewDirAtSlashTmp(prefix string) (*TempDir, error)

NewDirAtSlashTmp creates a new TempDir at /tmp

func (*TempDir) NewDeterministicDir

func (d *TempDir) NewDeterministicDir(name string) (*TempDir, error)

func (*TempDir) NewDir

func (d *TempDir) NewDir(prefix string) (*TempDir, error)

d.NewDir creates a new TempDir under d

func (*TempDir) Path

func (d *TempDir) Path() string

func (*TempDir) TearDown

func (d *TempDir) TearDown() error