fsnotify

Documentation

Index

• Constants
• type Event
  • func (e Event) String() string
• type Op
  • func (op Op) String() string
• type Watcher
  • func NewWatcher(logger log.Logger) (*Watcher, error)
  • func (w *Watcher) Add(name string) error
  • func (w *Watcher) AddOnEventHandler(onEventHandler *func(event Event))
  • func (w *Watcher) Close() error
  • func (w *Watcher) Remove(name string) error
  • func (w *Watcher) RemoveOnEventHandler(onEventHandler *func(event Event))

Constants

const (
	Create          = Op(fsnotify.Create)
	Remove          = Op(fsnotify.Remove)
	Rename          = Op(fsnotify.Rename)
	Chmod           = Op(fsnotify.Chmod)
	Write           = Op(fsnotify.Write)
	WatchingResumed = Op(1 << 31)
)

Types

type Event

type Event struct {
	// Path to the file or directory.
	//
	// Paths are relative to the input; for example with Add("dir") the Name
	// will be set to "dir/file" if you create that file, but if you use
	// Add("/path/to/dir") it will be "/path/to/dir/file".
	Name string

	// File operation that triggered the event.
	//
	// This is a bitmask and some systems may send multiple operations at once.
	// Use the Event.Has() method instead of comparing with ==.
	Op Op
}

Event represents a file system notification.

func (Event) String

func (e Event) String() string

String returns a string representation of the event with their path.

type Op

type Op fsnotify.Op

Op describes a set of file operations.

func (Op) String

func (op Op) String() string

type Watcher

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

func NewWatcher

func NewWatcher(logger log.Logger) (*Watcher, error)

NewWatcher creates a new Watcher. It's allows to watch a single file or a directory multiple times.

func (*Watcher) Add

func (w *Watcher) Add(name string) error

func (*Watcher) AddOnEventHandler

func (w *Watcher) AddOnEventHandler(onEventHandler *func(event Event))

func (*Watcher) Close

func (w *Watcher) Close() error

func (*Watcher) Remove

func (w *Watcher) Remove(name string) error

func (*Watcher) RemoveOnEventHandler

func (w *Watcher) RemoveOnEventHandler(onEventHandler *func(event Event))