path

README

path

Overview

A simple library to handle file path input in Go.

Features

• Hanlde absolute and relative paths
• Globbing (must be quoted)
• List files in directories recursivly
• Optional regex to filter results
• Cli via flag, see example

Caveats

When passing in globbed patterns via cli you must quote them, if you dont bash will expand them and could result in undesired results. go run cmd/main.go -path "/my/globbed/path/*"

Documentation

Index

• func Contains(input []Entry, needle string) bool
• func OnlyNames(input []Entry) []string
• func WatchDir(ctx context.Context, inputPath string, filter WatchFilter, ...) error
• type DateEntitiesFilter
  • func NewDateEntitiesFilter(from, to time.Time) DateEntitiesFilter
• type DateWatchFilter
  • func NewDateWatchFilter(from, to time.Time) DateWatchFilter
• type EntriesFilter
• type Entry
  • func FilterEntities(files []Entry, filter EntriesFilter) []Entry
  • func ListFiles(inputPath string) ([]Entry, error)
  • func ListFilesWithDateFilter(inputPath string, beginTime, endTime time.Time) ([]Entry, error)
  • func ListFilesWithFilter(inputPath string, filterRegex *regexp.Regexp) ([]Entry, error)
  • func ListFilesWithMapFilter(inputPath string, skipMap map[string]struct{}) ([]Entry, error)
  • func ListFilesWithPermissionsFilter(inputPath string, min, max uint32) ([]Entry, error)
  • func ListFilesWithSizeFilter(inputPath string, min, max int64) ([]Entry, error)
  • func NewEntry(inputPath string) (Entry, error)
  • func OnlyDirs(input []Entry) []Entry
  • func OnlyFiles(input []Entry) []Entry
  • func (e *Entry) IsDir() bool
  • func (e *Entry) String() string
• type NoopEntriesFilter
• type NoopWatchFilter
• type Path
  • func (p *Path) Get() []Entry
  • func (p *Path) Set(s string) error
  • func (p Path) String() string
• type PermissionsEntitiesFilter
  • func NewPermissionsEntitiesFilter(min, max uint32) PermissionsEntitiesFilter
• type PermissionsWatchFilter
  • func NewPermissionsWatchFilter(min, max uint32) PermissionsWatchFilter
• type RegexEntitiesFilter
  • func NewRegexEntitiesFilter(filterRegex *regexp.Regexp) RegexEntitiesFilter
• type RegexWatchFilter
  • func NewRegexWatchFilter(filterRegex *regexp.Regexp) RegexWatchFilter
• type SizeEntitiesFilter
  • func NewSizeEntitiesFilter(min, max int64) SizeEntitiesFilter
• type SizeWatchFilter
  • func NewSizeWatchFilter(min, max int64) SizeWatchFilter
• type SkipMapEntitiesFilter
  • func NewSkipMapEntitiesFilter(skipMap map[string]struct{}) SkipMapEntitiesFilter
• type SkipMapWatchFilter
  • func NewSkipMapWatchFilter(skipMap map[string]struct{}) SkipMapWatchFilter
• type WatchEvent
• type WatchFilter

Functions

func Contains

func Contains(input []Entry, needle string) bool

func OnlyNames

func OnlyNames(input []Entry) []string

OnlyNames returns a slice of absolute paths (strings) from a given Entry slice.

func WatchDir

func WatchDir(ctx context.Context, inputPath string, filter WatchFilter, files chan WatchEvent) error

Types

type DateEntitiesFilter

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

DateEntitiesFilter filters fs events by matching ensuring ModTime is within the given date range.

func NewDateEntitiesFilter

func NewDateEntitiesFilter(from, to time.Time) DateEntitiesFilter

type DateWatchFilter

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

DateWatchFilter filters fs events by matching ensuring ModTime is within the given date range.

func NewDateWatchFilter

func NewDateWatchFilter(from, to time.Time) DateWatchFilter

type EntriesFilter

type EntriesFilter interface {
	// contains filtered or unexported methods
}

EntitiesFilter interface facilitates filtering entry slices.

type Entry

type Entry struct {
	FileInfo     fs.FileInfo
	AbsolutePath string
}

Entry is the currency of this package.

func FilterEntities

func FilterEntities(files []Entry, filter EntriesFilter) []Entry

FilterEntities removes files from the slice if they are not accepted by the given filter function.

func ListFiles

func ListFiles(inputPath string) ([]Entry, error)

ListFiles recursively lists all files

func ListFilesWithDateFilter

func ListFilesWithDateFilter(inputPath string, beginTime, endTime time.Time) ([]Entry, error)

ListFilesWithDateFilter recursively lists all files, filtering based on modtime.

func ListFilesWithFilter

func ListFilesWithFilter(inputPath string, filterRegex *regexp.Regexp) ([]Entry, error)

ListFilesWithFilter recursively lists all files, filtering the names based on the given regex.

func ListFilesWithMapFilter

func ListFilesWithMapFilter(inputPath string, skipMap map[string]struct{}) ([]Entry, error)

ListFilesWithMapFilter recursively lists all files skipping those that exist in the skip map.

func ListFilesWithPermissionsFilter

func ListFilesWithPermissionsFilter(inputPath string, min, max uint32) ([]Entry, error)

ListFilesWithPermissionsFilter recursively lists all files skipping those that are not in the given range, inclusive.

func ListFilesWithSizeFilter

func ListFilesWithSizeFilter(inputPath string, min, max int64) ([]Entry, error)

ListFilesWithSizeFilter recursively lists all files skipping those that are not in the given range, inclusive.

func NewEntry

func NewEntry(inputPath string) (Entry, error)

NewEntry takes a filepath and expands ~ as well as other relative paths to absolute and stats them returning Entry.

func OnlyDirs

func OnlyDirs(input []Entry) []Entry

OnlyDirs filters an input slice by returning a slice containing only directories.

func OnlyFiles

func OnlyFiles(input []Entry) []Entry

OnlyFiles filters an input slice by returning a slice containing only files.

func (*Entry) IsDir

func (e *Entry) IsDir() bool

func (*Entry) String

func (e *Entry) String() string

type NoopEntriesFilter

type NoopEntriesFilter struct{}

NoopEntriesFilter always returns true, useful for testing.

type NoopWatchFilter

type NoopWatchFilter struct{}

type Path

type Path struct {
	GivenInput   string // exactly what the user typed
	ComputedPath Entry  // converts relative paths to absolute
	Files        []Entry
}

Path is a type whose sole purpose is to furfil the flag interface

func (*Path) Get

func (p *Path) Get() []Entry

Get fulfils the flag.Getter interface https://pkg.go.dev/flag#Getter

func (*Path) Set

func (p *Path) Set(s string) error

Set fulfils the flag.Value interface https://pkg.go.dev/flag#Value

func (Path) String

func (p Path) String() string

String fulfils the flag.Value interface https://pkg.go.dev/flag#Value

type PermissionsEntitiesFilter

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

PermissionsEntitiesFilter filters fs events by ensuring the given file permissions are within the given range.

func NewPermissionsEntitiesFilter

func NewPermissionsEntitiesFilter(min, max uint32) PermissionsEntitiesFilter

type PermissionsWatchFilter

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

PermissionsWatchFilter filters fs events by ensuring the given file permissions are within the given range.

func NewPermissionsWatchFilter

func NewPermissionsWatchFilter(min, max uint32) PermissionsWatchFilter

type RegexEntitiesFilter

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

RegexEntitiesFilter filters fs events by matching file names to a given regex.

func NewRegexEntitiesFilter

func NewRegexEntitiesFilter(filterRegex *regexp.Regexp) RegexEntitiesFilter

type RegexWatchFilter

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

RegexWatchFilter filters fs events by matching file names to a given regex.

func NewRegexWatchFilter

func NewRegexWatchFilter(filterRegex *regexp.Regexp) RegexWatchFilter

type SizeEntitiesFilter

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

SizeEntitiesFilter filters fs events by ensuring the given file within the given size range (in bytes).

func NewSizeEntitiesFilter

func NewSizeEntitiesFilter(min, max int64) SizeEntitiesFilter

type SizeWatchFilter

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

SizeWatchFilter filters fs events by ensuring the given file within the given size range (in bytes).

func NewSizeWatchFilter

func NewSizeWatchFilter(min, max int64) SizeWatchFilter

type SkipMapEntitiesFilter

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

SkipMapEntitiesFilter filters fs events by ensuring the given file is NOT within the given map.

func NewSkipMapEntitiesFilter

func NewSkipMapEntitiesFilter(skipMap map[string]struct{}) SkipMapEntitiesFilter

type SkipMapWatchFilter

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

SkipMapWatchFilter filters fs events by ensuring the given file is NOT within the given map.

func NewSkipMapWatchFilter

func NewSkipMapWatchFilter(skipMap map[string]struct{}) SkipMapWatchFilter

type WatchEvent

type WatchEvent struct {
	Entry
	fsnotify.Op
}

type WatchFilter

type WatchFilter interface {
	// contains filtered or unexported methods
}

WatchFilter interface facilitates filtering of file events.