watcher

package

v0.0.0-...-d46617c Latest Latest Go to latest Published: Mar 28, 2023 License: MIT Imports: 4 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

Repository

github.com/geotime/witch

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	// Added represents a file creation event.
	Added = "added"
	// Changed represents a file change event.
	Changed = "changed"
	// Removed represents a file removal event.
	Removed = "removed"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Event ¶

type Event struct {
	Type string
	Path string
}

Event represents a single detected file event.

type Watcher ¶

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

Watcher represents a simple struct for scanning and checking for any changes that occur in a set of watched files and directories.

func New ¶

func New() *Watcher

New instantiates and returns a new watcher struct.

func (*Watcher) Ignore ¶

func (w *Watcher) Ignore(arg string)

Ignore adds a single file, directory, or glob to the file ignore list.

func (*Watcher) NumTargets ¶

func (w *Watcher) NumTargets() (uint64, error)

NumTargets returns the number of currently watched targets.

func (*Watcher) ScanForEvents ¶

func (w *Watcher) ScanForEvents() ([]Event, error)

ScanForEvents returns any events that occurred since the last scan.

func (*Watcher) Watch ¶

func (w *Watcher) Watch(arg string)

Watch adds a single file, directory, or glob to the file watch list.

Source Files ¶

View all Source files

watcher.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL