fs

Documentation

Index

• type CachedFileWatcher
  • func NewCachedFileWatcher(logger *zap.SugaredLogger) (CachedFileWatcher, error)
• type CachedWatchCallback
• type FileWatcher
  • func NewWatcher(logger *zap.SugaredLogger) (FileWatcher, error)
• type Poller
  • func NewPoller(period time.Duration, logger *zap.SugaredLogger) (Poller, error)
• type PollerCallback
• type WatchCallback

Types

type CachedFileWatcher

type CachedFileWatcher interface {
	// Start the FileWatcher process.
	Start(ctx context.Context)
	// Add a file path to be watched.
	Add(path string, cb CachedWatchCallback) error
	// GetContent of watched file.
	GetContent(path string) ([]byte, error)
}

CachedFileWatcher is a FileWatcher that caches and tracks the contents of watched files.

func NewCachedFileWatcher

func NewCachedFileWatcher(logger *zap.SugaredLogger) (CachedFileWatcher, error)

NewCachedFileWatcher creates a new FileWatcher object that register files and calls back when they change.

type CachedWatchCallback

type CachedWatchCallback func(content []byte)

type FileWatcher

type FileWatcher interface {
	Add(path string, cb WatchCallback) error
	Start(ctx context.Context)
}

FileWatcher object tracks changes to files.

func NewWatcher

func NewWatcher(logger *zap.SugaredLogger) (FileWatcher, error)

NewWatcher creates a new FileWatcher object that register files and calls back when they change.

type Poller

type Poller interface {
	Add(path string, cb PollerCallback) error
	Start(ctx context.Context)
	GetContent(path string) ([]byte, error)
}

func NewPoller

func NewPoller(period time.Duration, logger *zap.SugaredLogger) (Poller, error)

type PollerCallback

type PollerCallback func(content []byte)

type WatchCallback

type WatchCallback func()

WatchCallback is called when a watched file is updated.