Back to godoc.org
github.com/howeyc/fsnotify

Package fsnotify

v0.9.0
Latest Go to latest
Published: Feb 27, 2014 | License: BSD-3-Clause | Module: github.com/howeyc/fsnotify

Overview

Package fsnotify implements file system notification.

Index

Examples

Package Files

Constants

const (
	FSN_CREATE = 1
	FSN_MODIFY = 2
	FSN_DELETE = 4
	FSN_RENAME = 8

	FSN_ALL = FSN_MODIFY | FSN_DELETE | FSN_RENAME | FSN_CREATE
)

type FileEvent

type FileEvent struct {
	Name string // File name (optional)
	// contains filtered or unexported fields
}

func (*FileEvent) IsAttrib

func (e *FileEvent) IsAttrib() bool

IsAttrib reports whether the FileEvent was triggered by a change in the file metadata.

func (*FileEvent) IsCreate

func (e *FileEvent) IsCreate() bool

IsCreate reports whether the FileEvent was triggered by a creation

func (*FileEvent) IsDelete

func (e *FileEvent) IsDelete() bool

IsDelete reports whether the FileEvent was triggered by a delete

func (*FileEvent) IsModify

func (e *FileEvent) IsModify() bool

IsModify reports whether the FileEvent was triggered by a file modification or attribute change

func (*FileEvent) IsRename

func (e *FileEvent) IsRename() bool

IsRename reports whether the FileEvent was triggered by a change name

func (*FileEvent) String

func (e *FileEvent) String() string

String formats the event e in the form "filename: DELETE|MODIFY|..."

type Watcher

type Watcher struct {
	Error chan error // Errors are sent on this channel

	Event chan *FileEvent // Events are returned on this channel
	// contains filtered or unexported fields
}

func NewWatcher

func NewWatcher() (*Watcher, error)

NewWatcher creates and returns a new inotify instance using inotify_init(2)

Example

Code:

watcher, err := fsnotify.NewWatcher()
if err != nil {
	log.Fatal(err)
}

go func() {
	for {
		select {
		case ev := <-watcher.Event:
			log.Println("event:", ev)
		case err := <-watcher.Error:
			log.Println("error:", err)
		}
	}
}()

err = watcher.Watch("/tmp/foo")
if err != nil {
	log.Fatal(err)
}

func (*Watcher) Close

func (w *Watcher) Close() error

Close closes an inotify watcher instance It sends a message to the reader goroutine to quit and removes all watches associated with the inotify instance

func (*Watcher) RemoveWatch

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

Remove a watch on a file

func (*Watcher) Watch

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

Watch a given file path

func (*Watcher) WatchFlags

func (w *Watcher) WatchFlags(path string, flags uint32) error

Watch a given file path for a particular set of notifications (FSN_MODIFY etc.)

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier