fsnotify

Documentation

Overview

Package fsnotify implements filesystem notification,.

Index

• func DefaultIsIgnorePath(path string) bool
• type FileEvent
• type Runner
  • func NewRunner(bufferSize int) (*Runner, error)
  • func (runner *Runner) Run(work func())
• type Watcher
  • func NewWatcher(bufferSize int) (watcher *Watcher, err error)
  • func (w *Watcher) Close() error
  • func (w *Watcher) GetErrorChan() chan error
  • func (w *Watcher) GetEventChan() chan *FileEvent
  • func (w *Watcher) WatchRecursion(path string) error

Functions

func DefaultIsIgnorePath

func DefaultIsIgnorePath(path string) bool

Types

type FileEvent

type FileEvent struct {
	*originFsnotify.FileEvent
	Name string
	Time time.Time
}

it is a wrapper of github.com/howeyc/fsnotify.FileEvent

type Runner

type Runner struct {
	*Watcher
	//wait WaitTime to run your function (default 0.2s)
	WaitTime time.Duration
	//whether init run this function (default true)
	InitRun bool
}

watch and run a function you should handle error in Watcher and add some files to watch (at least)

func NewRunner

func NewRunner(bufferSize int) (*Runner, error)

func (*Runner) Run

func (runner *Runner) Run(work func())

this function will block forever

type Watcher

type Watcher struct {
	*originFsnotify.Watcher
	Event chan *FileEvent
	Error chan error
	//default ignore all file start with "."
	IsIgnorePath func(path string) bool
	//default is nil,if is nil ,error send through Error chan,if is not nil,error handle by this func
	ErrorHandler func(err error)
	// contains filtered or unexported fields
}

func NewWatcher

func NewWatcher(bufferSize int) (watcher *Watcher, err error)

func (*Watcher) Close

func (w *Watcher) Close() error

func (*Watcher) GetErrorChan

func (w *Watcher) GetErrorChan() chan error

func (*Watcher) GetEventChan

func (w *Watcher) GetEventChan() chan *FileEvent

func (*Watcher) WatchRecursion

func (w *Watcher) WatchRecursion(path string) error