watchfs

Documentation

Index

• Variables
• func Join(watches ...*Watch) <-chan Event
• type Config
• type Event
  • func (e Event) String() string
• type EventType
• type FS
  • func New(fsys fs.FS) *FS
  • func (f *FS) Watch(name string, cfg *Config) (*Watch, error)
• type Watch
  • func NewWatch(path string, cfg Config) (*Watch, chan Event, chan bool)
  • func WatchFile(fsys fs.FS, name string, cfg *Config) (*Watch, error)
  • func (w *Watch) Close()
  • func (w *Watch) Iter() <-chan Event
• type WatchFS

Variables

var Interval time.Duration = 500 * time.Millisecond

Functions

func Join

func Join(watches ...*Watch) <-chan Event

Types

type Config

type Config struct {
	Recursive bool
	EventMask uint
	Ignores   []string
	Handler   func(Event)
}

type Event

type Event struct {
	Type    EventType
	Path    string
	OldPath string
	Err     error
	fs.FileInfo
}

func (Event) String

func (e Event) String() string

type EventType

type EventType uint

const (
	EventError EventType = 1 << iota
	EventCreate
	EventWrite
	EventRemove
	EventRename
	EventChmod
	EventMove
)

type FS

type FS struct {
	fs.FS
	// contains filtered or unexported fields
}

func New

func New(fsys fs.FS) *FS

func (*FS) Watch

func (f *FS) Watch(name string, cfg *Config) (*Watch, error)

type Watch

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

func NewWatch

func NewWatch(path string, cfg Config) (*Watch, chan Event, chan bool)

NewWatch is for building your own WatchFS implementation. Use the returned chan Event for sending events and the chan bool for waiting for a close.

func WatchFile

func WatchFile(fsys fs.FS, name string, cfg *Config) (*Watch, error)

func (*Watch) Close

func (w *Watch) Close()

func (*Watch) Iter

func (w *Watch) Iter() <-chan Event

type WatchFS

type WatchFS interface {
	fs.FS
	// Wrapper Filesystems should check their children for implementations before providing their own.
	// Return `errors.ErrUnsupported` to signal that parent Filesystems should use their implementation instead.
	Watch(name string, cfg *Config) (*Watch, error)
}