watch

Documentation

Index

• type Option
  • func WithDirs(dirs ...string) Option
  • func WithErrGroup(eg errgroup.Group) Option
  • func WithOnChange(f func(ctx context.Context, name string) error) Option
  • func WithOnChmod(f func(ctx context.Context, name string) error) Option
  • func WithOnCreate(f func(ctx context.Context, name string) error) Option
  • func WithOnDelete(f func(ctx context.Context, name string) error) Option
  • func WithOnError(f func(ctx context.Context, err error) error) Option
  • func WithOnRename(f func(ctx context.Context, name string) error) Option
  • func WithOnWrite(f func(ctx context.Context, name string) error) Option
• type Watcher
  • func New(opts ...Option) (Watcher, error)

Types

type Option

type Option func(w *watch) error

func WithDirs

func WithDirs(dirs ...string) Option

func WithErrGroup

func WithErrGroup(eg errgroup.Group) Option

func WithOnChange

func WithOnChange(f func(ctx context.Context, name string) error) Option

func WithOnChmod

func WithOnChmod(f func(ctx context.Context, name string) error) Option

func WithOnCreate

func WithOnCreate(f func(ctx context.Context, name string) error) Option

func WithOnDelete

func WithOnDelete(f func(ctx context.Context, name string) error) Option

func WithOnError

func WithOnError(f func(ctx context.Context, err error) error) Option

func WithOnRename

func WithOnRename(f func(ctx context.Context, name string) error) Option

func WithOnWrite

func WithOnWrite(f func(ctx context.Context, name string) error) Option

type Watcher

type Watcher interface {
	Start(ctx context.Context) (<-chan error, error)
	Add(dirs ...string) error
	Remove(dirs ...string) error
	Stop(ctx context.Context) error
}

Watcher is an interface that represents a file monitor.

func New

func New(opts ...Option) (Watcher, error)

New returns Watcher implementation.