# watcher

**Repository Path**: antonyzeus/watcher

## Basic Information

- **Project Name**: watcher
- **Description**: 修改后的watcher库
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-08
- **Last Updated**: 2025-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# watcher

## Installation

```shell
go get -u gitee.com/antonyzeus/watcher
```

## Features

- **可自定义轮询间隔**
- **事件过滤**
- **递归/非递归监控文件夹**
- **忽略隐藏文件**
- **忽略指定文件/文件夹**
- **通知基于事件的文件 `os.FileInfo` 信息（如名称、修改时间、是否为目录等）**
- **通知文件完整路径（重命名/移动事件时包含新旧路径）**
- **限制每监控周期接收的事件数量**
- **列出被监控的文件列表**
- **触发自定义事件**

## Example

```go
package main

import (
	"log"
	"time"

	"gitee.com/antonyzeus/watcher"
)

type File struct {
}

func (f *File) ListRecursive(name string, ignored map[string]struct{}, ignoreHidden bool,
	ffh []watcher.FilterFileHookFunc) (map[string]os.FileInfo, error) {
}

func main() {
    w := watcher.NewWatcher(new(File), "devdb")

	// SetMaxEvents to 1 to allow at most 1 event's to be received
	// on the Event channel per watching cycle.
	//
	// If SetMaxEvents is not set, the default is to send all events.
	w.SetMaxEvents(1)

	// Only notify rename and move events.
	w.FilterOps(watcher.Rename, watcher.Move)

	// Only files that match the regular expression during file listings
	// will be watched.
	r := regexp.MustCompile("^abc$")
	w.AddFilterHook(watcher.RegexFilterHook(r, false))

	go func() {
		for {
			select {
			case event := <-w.Event:	
				log.Println(event) // Print the event's info.
			case err := <-w.Error:
				log.Fatalln(err)
			case <-w.Closed:
				return
			}
		}
	}()

	// Watch this folder for changes.
	if err := w.Add("."); err != nil {
		log.Fatalln(err)
	}

	// Watch test_folder recursively for changes.
	if err := w.AddRecursive("../test_folder"); err != nil {
		log.Fatalln(err)
	}

	// Print a list of all of the files and folders currently
	// being watched and their paths.
	for path, f := range w.WatchedFiles() {
		log.Printf("%s: %s\n", path, f.Name())
	}

	log.Println()

	// Trigger 2 events after watcher started.
	go func() {
		w.Wait()
		w.TriggerEvent(watcher.Create, nil)
		w.TriggerEvent(watcher.Remove, nil)
	}()

	// Start the watching process - it'll check for changes every 100ms.
	if err := w.Start(time.Millisecond * 100); err != nil {
		log.Fatalln(err)
	}
}
```