watcher

Documentation

Index

• type File
  • func NewFile() (*File, error)
  • func (f *File) Add(filepath string) error
  • func (f *File) Shutdown()
  • func (f *File) Start(notifier Notification)
• type Notification
• type Notifier

Types

type File

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

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

func NewFile

func NewFile() (*File, error)

NewFile is a standard constructor

func (*File) Add

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

Add adds a file to start watching

func (*File) Shutdown

func (f *File) Shutdown()

Shutdown stop the file watching run loop

func (*File) Start

func (f *File) Start(notifier Notification)

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

type Notification

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

Notification is the delegate methods from the Notifier

type Notifier

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

Notifier is the base interface for file watching