fswatch

package

v2.15.0 Latest Latest Go to latest Published: Oct 4, 2026 License: BSD-3-Clause Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/getarcaneapp/arcane

Links

Open Source Insights

Documentation ¶

Overview ¶

Package fswatch stays on os.* rather than acfs: it watches arbitrary user-configured paths and deliberately follows symlinks that may resolve outside any confinement root, which acfs cannot do.

Index ¶

type Watcher
- func NewWatcher(watchPath string, opts WatcherOptions) (*Watcher, error)
type WatcherOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Watcher ¶

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

func NewWatcher ¶

func NewWatcher(watchPath string, opts WatcherOptions) (*Watcher, error)

func (*Watcher) Start ¶

func (fw *Watcher) Start(ctx context.Context) error

func (*Watcher) Stop ¶

func (fw *Watcher) Stop() error

Stop closes the watcher and waits for accepted callbacks.

func (*Watcher) StopWatching ¶ added in v2.15.0

func (fw *Watcher) StopWatching() error

StopWatching closes the watch loop before its owner joins callbacks.

type WatcherOptions ¶

type WatcherOptions struct {
	Debounce          time.Duration
	OnChange          func(ctx context.Context)
	OnChangePaths     func(ctx context.Context, paths []string)
	MaxDepth          int
	FollowSymlinkDirs bool
}

Source Files ¶

View all Source files

watcher.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL