watcher

Documentation

Index

• type FileChangedMsg
• type Watcher
  • func New() (*Watcher, error)
  • func (w *Watcher) Start(ctx context.Context, filePath string)
  • func (w *Watcher) WatchFileCmd() tea.Cmd
• type WatcherErrMsg
  • func (e WatcherErrMsg) Error() string

Types

type FileChangedMsg

type FileChangedMsg struct{}

FileChangedMsg is sent when the watched file is modified.

type Watcher

type Watcher struct {
	Events chan tea.Msg // Channel to send messages back to Bubble Tea
	Errors chan error   // Channel to send errors (raw errors)
	// contains filtered or unexported fields
}

Watcher manages the file system watcher.

func New

func New() (*Watcher, error)

New creates a new Watcher.

func (*Watcher) Start

func (w *Watcher) Start(ctx context.Context, filePath string)

Start begins watching the specified file. It runs in a goroutine and sends events/errors on the respective channels.

func (*Watcher) WatchFileCmd

func (w *Watcher) WatchFileCmd() tea.Cmd

WatchFileCmd returns a command that listens for watcher events.

type WatcherErrMsg

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

WatcherErrMsg is sent when the watcher encounters an error.

func (WatcherErrMsg) Error

func (e WatcherErrMsg) Error() string