watcher

Documentation

Index

• type IsWatchableFileFunc
• type Option
  • func WithEventDebounceDuration(duration time.Duration) Option
  • func WithIsWatchableFileFunc(f IsWatchableFileFunc) Option
  • func WithLogger(logger logger.Logger) Option
  • func WithPaths(paths ...string) Option
  • func WithRemoveObjectFunc(f RemoveObjectFunc) Option
  • func WithResolveObjectPathFunc(f ResolveObjectPathFunc) Option
  • func WithUpdateObjectFunc(f UpdateObjectFunc) Option
• type Options
• type RemoveObjectFunc
• type ResolveObjectPathFunc
• type UpdateObjectFunc
• type Watcher
  • func New(opts ...Option) (Watcher, error)

Types

type IsWatchableFileFunc

type IsWatchableFileFunc func(path string) bool

type Option

type Option func(*Options)

func WithEventDebounceDuration

func WithEventDebounceDuration(duration time.Duration) Option

func WithIsWatchableFileFunc

func WithIsWatchableFileFunc(f IsWatchableFileFunc) Option

func WithLogger

func WithLogger(logger logger.Logger) Option

func WithPaths

func WithPaths(paths ...string) Option

func WithRemoveObjectFunc

func WithRemoveObjectFunc(f RemoveObjectFunc) Option

func WithResolveObjectPathFunc

func WithResolveObjectPathFunc(f ResolveObjectPathFunc) Option

func WithUpdateObjectFunc

func WithUpdateObjectFunc(f UpdateObjectFunc) Option

type Options

type Options struct {
	Logger           logger.Logger
	Paths            []string
	DebounceDuration time.Duration

	UpdateObjectFunc      UpdateObjectFunc
	RemoveObjectFunc      RemoveObjectFunc
	ResolveObjectPathFunc ResolveObjectPathFunc
	IsWatchableFileFunc   IsWatchableFileFunc
}

type RemoveObjectFunc

type RemoveObjectFunc func(path string) error

type ResolveObjectPathFunc

type ResolveObjectPathFunc func(path string) string

type UpdateObjectFunc

type UpdateObjectFunc func(path string) error

type Watcher

type Watcher interface {
	Close() error
	SetPaths(paths ...string) error
}

func New

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