fsevent

Documentation

Index

• type Event
  • func (e Event) String() string
• type Op
  • func NewOp(s string) Op
  • func (op Op) String() string
• type WatchPathConfig
  • func (c *WatchPathConfig) Validate() error

Types

type Event

type Event struct {
	// Relative path to the file or directory.
	Name string `json:"name"`
	// File operation that triggered the event.
	Op Op `json:"op"`
}

Event represents a single file system notification.

func (Event) String

func (e Event) String() string

String returns a string representation of the event in the form "file: REMOVE|WRITE|..."

type Op

type Op uint32

Op describes a set of file operations.

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

These are the generalized file operations that can trigger a notification.

func NewOp

func NewOp(s string) Op

NewOp converts a given string to Op

func (Op) String

func (op Op) String() string

type WatchPathConfig

type WatchPathConfig struct {
	// Directory to watch for events
	Directory string `json:"directory"`
	// Path is relative path of object to watch with respect to the directory
	Path string `json:"path,omitempty"`
	// PathRegexp is regexp of relative path of object to watch with respect to the directory
	PathRegexp string `json:"pathRegexp,omitempty"`
}

func (*WatchPathConfig) Validate

func (c *WatchPathConfig) Validate() error

Validate validates WatchPathConfig