package fsnotify

Import Path
	github.com/fsnotify/fsnotify (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	   d➜ fsnotify.go
		Package fsnotify provides a platform-independent interface for file system notifications.

	      inotify.go
	      inotify_poller.go
Package-Level Type Names (total 5, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Event (struct)
		Event represents a single file system notification.

		Fields (total 2, both are exported)
			Name string
				// Relative path to the file or directory.

			Op Op
				// File operation that triggered the event.

		Methods (total 2, in which 1 are exported)
			( T) String() string
				String returns a string representation of the event in the form
				"file: REMOVE|WRITE|..."

			/* one unexported ... *//* one unexported: */
			(*T) ignoreLinux(mask uint32) bool
				Certain types of events can be "ignored" and not sent over the Events
				channel. Such as events marked ignore by the kernel, or MODIFY events
				against files that do not exist.

		Implements (at least 4, in which 1 are exported)
			 T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 T : context.stringer
			 T : os/signal.stringer
			 T : runtime.stringer
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newEvent(name string, mask uint32) Event

	 type Op uint32 (basic type)
		Op describes a set of file operations.

		Methods (only one, which is exported)
			( T) String() string
		Implements (at least 4, in which 1 are exported)
			 T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 T : context.stringer
			 T : os/signal.stringer
			 T : runtime.stringer
		As Types Of (total 5, all are exported)
			const Chmod
			const Create
			const Remove
			const Rename
			const Write

	 type Watcher (struct)
		Watcher watches a set of files, delivering events to a channel.

		Fields (total 9, in which 2 are exported)
			Errors chan error
			Events chan Event
			/* 7 unexporteds ... *//* 7 unexporteds: */
			done chan struct{}
				// Channel for sending a "quit message" to the reader goroutine

			doneResp chan struct{}
				// Channel to respond to Close

			fd int
			mu sync.Mutex
				// Map access

			paths map[int]string
				// Map of watched paths (key: watch descriptor)

			poller *fdPoller
			watches map[string]*watch
				// Map of inotify watches (key: path)

		Methods (total 5, in which 3 are exported)
			(*T) Add(name string) error
				Add starts watching the named file or directory (non-recursively).

			(*T) Close() error
				Close removes all watches and closes the events channel.

			(*T) Remove(name string) error
				Remove stops watching the named file or directory (non-recursively).

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) isClosed() bool
			(*T) readEvents()
				readEvents reads from the inotify file descriptor, converts the
				received events into Event objects and sends them via the Events channel

		Implements (at least one exported)
			*T : io.Closer
		As Outputs Of (at least 2, in which 1 are exported)
			func NewWatcher() (*Watcher, error)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/spf13/viper.newWatcher() (*viper.watcher, error)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type fdPoller (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			epfd int
				// Epoll file descriptor

			fd int
				// File descriptor (as returned by the inotify_init() syscall)

			pipe [2]int
				// Pipe for waking up

		Methods (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*T) clearWake() error
			(*T) close()
				Close all poller file descriptors, but not the one passed to it.

			(*T) wait() (bool, error)
				Wait using epoll.
				Returns true if something is ready to be read,
				false if there is not.

			(*T) wake() error
				Close the write end of the poller.

		As Outputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func emptyPoller(fd int) *fdPoller
			func newFdPoller(fd int) (*fdPoller, error)

	 type watch (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			flags uint32
				// inotify flags of this watch (see inotify(7) for the list of valid flags)

			wd uint32
				// Watch descriptor (as returned by the inotify_add_watch() syscall)



Package-Level Functions (total 4, in which 1 are exported)

	 func NewWatcher() (*Watcher, error)
		NewWatcher establishes a new watcher with the underlying OS and begins waiting for events.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func emptyPoller(fd int) *fdPoller
	 func newEvent(name string, mask uint32) Event
		newEvent returns an platform-independent Event based on an inotify mask.

	 func newFdPoller(fd int) (*fdPoller, error)
		Create a new inotify poller.
		This creates an inotify handler, and an epoll handler.


Package-Level Variables (only one, which is exported)

	  var ErrEventOverflow error
		Common errors that can be reported by a watcher


Package-Level Constants (total 5, all are exported)

	const Chmod Op = 16
		These are the generalized file operations that can trigger a notification.

	const Create Op = 1
		These are the generalized file operations that can trigger a notification.

	const Remove Op = 4
		These are the generalized file operations that can trigger a notification.

	const Rename Op = 8
		These are the generalized file operations that can trigger a notification.

	const Write Op = 2
		These are the generalized file operations that can trigger a notification.

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.