watchdrain

package module

v0.0.0-...-61bbbae Latest Latest Go to latest Published: Feb 20, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mabego/watchdrain

Links

Open Source Insights

README ¶

watchdrain is a simple command line tool that monitors a directory until it is empty of files.

I wrote it as an exercise to experiment with Go channels, goroutines, and testing in Go.

How to Install

Using `go run`

git clone https://github.com/mabego/watchdrain.git

cd watchdrain

go run ./cmd/watchdrain/main.go <dir>

Building a binary

git clone https://github.com/mabego/watchdrain.git

cd watchdrain

sudo go build -o /usr/local/bin/watchdrain ./cmd/watchdrain/

watchdrain <dir>

CLI Options

watchdrain -h
watchdrain watches a directory until it is empty of files
Usage of watchdrain:
watchdrain <dir>
  -threshold uint
        Stop watching a directory if file create events exceed remove events by a threshold
        threshold = create events - remove events
        The lowest threshold is 1. Increase to allow more create events while watching.
  -timer duration
        Set a timer. Default is 5 minutes. (default 5m0s)
  -v    Log file create and remove events
watchdrain -timer 1m -threshold 1 -v <dir>

Documentation ¶

Index ¶

Constants
Variables
type Dir
- func NewDir(dirName string) (*Dir, error)
- func (d *Dir) WatchDrain(opt *Options) (bool, error)
type Options
- func NewOptions(timer time.Duration, threshold uint, verbose bool) *Options

Constants ¶

View Source

const (
	Create event = iota
	Remove
)

Events that trigger a notification to eventCh

Variables ¶

View Source

var (
	// ErrThresholdExceeded is returned when file creation events exceed removal events by a set threshold
	ErrThresholdExceeded = errors.New("threshold exceeded")
	ErrTimerEnded        = errors.New("timer ended")
)

Functions ¶

This section is empty.

Types ¶

type Dir ¶

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

Dir represents a directory to watch drain of files

func NewDir ¶

func NewDir(dirName string) (*Dir, error)

NewDir returns a new Dir to watch drain

func (*Dir) WatchDrain ¶

func (d *Dir) WatchDrain(opt *Options) (bool, error)

WatchDrain watches a directory until it is empty of files or a timer ends or a threshold is exceeded

type Options ¶

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

Options for WatchDrain

func NewOptions ¶

func NewOptions(timer time.Duration, threshold uint, verbose bool) *Options

NewOptions returns Options, including an eventCh channel if a threshold is set

Source Files ¶

View all Source files

watchdrain.go

Directories ¶

Path	Synopsis
cmd
watchdrain

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