fsnotify

Documentation

Index

• type EventData
• type Notifier
  • func New() (*Notifier, error)
  • func (n *Notifier) IsStarted() bool
  • func (n *Notifier) IsStopped() bool
  • func (n *Notifier) OnError(callback OnError) *Notifier
  • func (n *Notifier) Remove(path string) *Notifier
  • func (n *Notifier) Start() *Notifier
  • func (n *Notifier) Stop() *Notifier
  • func (n *Notifier) Watch(path string, watchConfig WatchConfig) *Notifier
• type OnError
• type Op
• type WatchCallback
• type WatchConfig

Types

type EventData

type EventData struct {
	// This is the path where it happened!
	Path string
	// This is the time when happened the event
	Time time.Time
	// This is the filtered Name
	Name string
	// This is the operation that happened
	Op Op
}

This is the Event structure when we receive from the watcher

type Notifier

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

func New

func New() (*Notifier, error)

func (*Notifier) IsStarted

func (n *Notifier) IsStarted() bool

func (*Notifier) IsStopped

func (n *Notifier) IsStopped() bool

func (*Notifier) OnError

func (n *Notifier) OnError(callback OnError) *Notifier

func (*Notifier) Remove

func (n *Notifier) Remove(path string) *Notifier

Remove the watcher!

func (*Notifier) Start

func (n *Notifier) Start() *Notifier

func (*Notifier) Stop

func (n *Notifier) Stop() *Notifier

func (*Notifier) Watch

func (n *Notifier) Watch(
	path string,
	watchConfig WatchConfig,
) *Notifier

type OnError

type OnError func(err error)

type Op

type Op fsnotify.Op

const (
	Create Op = 1 << iota
	Write
	Remove
	Rename
	Chmod
)

Just extending! These are the operations of an event!

type WatchCallback

type WatchCallback func(e EventData)

type WatchConfig

type WatchConfig struct {
	// This is the callback which should be called!
	Callback WatchCallback
	// What operations should listen on!
	Op []Op
}

This is the structure when we send the configuration to the watcher!