README
¶
File system notifications for Go
Go 1.3+ required.
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 | Planned |
| 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
Two major versions of fsnotify exist.
fsnotify.v0 is API-compatible with howeyc/fsnotify. Bugfixes may be backported, but I recommend upgrading to v1.
import "gopkg.in/fsnotify.v0"
* Refer to the package as fsnotify (without the .v0 suffix).
fsnotify.v1 provides a new API based on this design document. You can import v1 with:
import "gopkg.in/fsnotify.v1"
Further API changes are planned, but a new major revision will be tagged, so you can depend on the v1 API.
Master may have unreleased changes. Use it to test the very latest code or when contributing, but don't expect it to remain API-compatible:
import "github.com/go-fsnotify/fsnotify"
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 ¶
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.
Example ¶
package main
import (
"log"
"github.com/go-fsnotify/fsnotify"
)
func main() {
watcher, err := fsnotify.NewWatcher()
if err != nil {
log.Fatal(err)
}
defer watcher.Close()
done := make(chan bool)
go func() {
for {
select {
case event := <-watcher.Events:
log.Println("event:", event)
if event.Op&fsnotify.Write == fsnotify.Write {
log.Println("modified file:", event.Name)
}
case err := <-watcher.Errors:
log.Println("error:", err)
}
}
}()
err = watcher.Add("/tmp/foo")
if err != nil {
log.Fatal(err)
}
<-done
}
func (*Watcher) Add ¶
Add starts watching the named file or directory (non-recursively).
func (*Watcher) Close ¶
Close removes all watches and closes the events channel.
Source Files
¶
- fsnotify.go
- inotify.go
- inotify_poller.go