fs

Documentation

Index

• Variables
• type NotifyWrapper
  • func NewFSWatcher(opts ...Option) (*NotifyWrapper, error)
  • func (w *NotifyWrapper) AddPath(path string) error
  • func (w *NotifyWrapper) Close() error
  • func (w *NotifyWrapper) Start() error
• type Option
  • func OnPath(path string) Option
  • func OnPaths(paths ...string) Option
  • func WithErrorChainAsHandler(eventsCh chan<- error) Option
  • func WithErrorEventHandler(handler func(error)) Option
  • func WithEventChainAsHandler(eventsCh chan<- fsnotify.Event) Option
  • func WithEventHandler(handler func(fsnotify.Event)) Option

Variables

var (
	ErrFSWatcherStartedNotAllowingNewPath = errors.New("watcher already started, cannot add new path")
	ErrFSWatcherHasNoPathsConfigured      = errors.New("watcher has no paths")
)

Types

type NotifyWrapper

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

func NewFSWatcher

func NewFSWatcher(opts ...Option) (*NotifyWrapper, error)

func (*NotifyWrapper) AddPath

func (w *NotifyWrapper) AddPath(path string) error

func (*NotifyWrapper) Close

func (w *NotifyWrapper) Close() error

func (*NotifyWrapper) Start

func (w *NotifyWrapper) Start() error

type Option

type Option func(*NotifyWrapper) error

Option is used to configure a NotifyWrapper.

func OnPath

func OnPath(path string) Option

func OnPaths

func OnPaths(paths ...string) Option

func WithErrorChainAsHandler

func WithErrorChainAsHandler(eventsCh chan<- error) Option

func WithErrorEventHandler

func WithErrorEventHandler(handler func(error)) Option

func WithEventChainAsHandler

func WithEventChainAsHandler(eventsCh chan<- fsnotify.Event) Option

func WithEventHandler

func WithEventHandler(handler func(fsnotify.Event)) Option