README ¶
File system notifications for Go
fsnotify utilizes golang.org/x/sys rather than syscall
from the standard library. Ensure you have the latest version installed by running:
go get -u golang.org/x/sys/...
Cross platform: Windows, Linux, BSD and OS X.
Adapter | OS | Status |
---|---|---|
inotify | Linux 2.6.27 or later, Android* | Supported |
kqueue | BSD, OS X, iOS* | Supported |
ReadDirectoryChangesW | Windows | Supported |
FSEvents | OS X | Planned |
FEN | Solaris 11 | In Progress |
fanotify | Linux 2.6.37+ | |
USN Journals | Windows | Maybe |
Polling | All | Maybe |
* Android and iOS are untested.
Please see the documentation for usage. Consult the Wiki for the FAQ and further information.
API stability
fsnotify is a fork of howeyc/fsnotify with a new API as of v1.0. The API is based on this design document.
All releases are tagged based on Semantic Versioning. Further API changes are planned, and will be tagged with a new major revision number.
Go 1.6 supports dependencies located in the vendor/
folder. Unless you are creating a library, it is recommended that you copy fsnotify into vendor/github.com/fsnotify/fsnotify
within your project, and likewise for golang.org/x/sys
.
Contributing
Please refer to CONTRIBUTING before opening an issue or pull request.
Example
See example_test.go.
Related Projects
Documentation ¶
Overview ¶
Package fsnotify provides a platform-independent interface for file system notifications.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Event ¶ added in v1.0.0
type Event struct { Name string // Relative path to the file or directory. Op Op // File operation that triggered the event. }
Event represents a single file system notification.
type Watcher ¶
type Watcher struct { Events chan Event Errors chan error // contains filtered or unexported fields }
Watcher watches a set of files, delivering events to a channel.
func NewWatcher ¶
NewWatcher establishes a new watcher with the underlying OS and begins waiting for events.
func (*Watcher) Add ¶ added in v1.0.0
Add starts watching the named file or directory (non-recursively).