watcher

package

v0.0.0-...-455eedf Latest Latest Go to latest Published: Nov 28, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

This section is empty.

This section is empty.

This section is empty.

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

File is a file watcher that notifies when a file has been changed

func NewFile() (*File, error)

NewFile is a standard constructor

func (f *File) Add(filepath string) error

Add adds a file to start watching

func (f *File) Shutdown()

Shutdown stop the file watching run loop

func (f *File) Start(notifier Notification)

Start is a runloop to watch for files changes from the file paths added from Add()

type Notification interface {
	WatcherItemDidChange(string)
	WatcherDidError(error)
}

Notification is the delegate methods from the Notifier

type Notifier interface {
	Start(Notification)
	Add(string) error
	Shutdown()
}

Notifier is the base interface for file watching