recwatch

package
v0.0.0-...-328360e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2024 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package recwatch provides recursive file watching events via fsnotify.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Event

type Event struct {
	Error error
	Body  *fsnotify.Event
}

Event represents a watcher event. These can include errors.

type Option

type Option func(*recwatchOptions)

Option is a type that can be used to configure the recwatcher.

func Debug

func Debug(debug bool) Option

Debug specifies whether we should run in debug mode or not.

func Logf

func Logf(logf func(format string, v ...interface{})) Option

Logf passes a logger function that we can use if so desired.

type RecWatcher

type RecWatcher struct {
	// Path is the computer path that we're watching.
	Path string

	// Recurse specifies if we should watch recursively.
	// TODO: Should this get converted into an Option?
	Recurse bool

	// Opts are the list of options that we are using this with.
	Opts []Option
	// contains filtered or unexported fields
}

RecWatcher is the struct for the recursive watcher. Run Init() on it.

func NewRecWatcher

func NewRecWatcher(path string, recurse bool, opts ...Option) (*RecWatcher, error)

NewRecWatcher creates an initializes a new recursive watcher.

func (*RecWatcher) Close

func (obj *RecWatcher) Close() error

Close shuts down the watcher.

func (*RecWatcher) Events

func (obj *RecWatcher) Events() chan Event

Events returns a channel of events. These include events for errors.

func (*RecWatcher) Init

func (obj *RecWatcher) Init() error

Init starts the recursive file watcher.

func (*RecWatcher) Watch

func (obj *RecWatcher) Watch() error

Watch is the primary listener for this resource and it outputs events.

Jump to

Keyboard shortcuts

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