ffinder

README

file-finder

File Finder Tool

Documentation

Index

• func GetDirConfigFile(ctx context.Context) (name string)
• func WithDirConfigFile(name string, ctx context.Context) context.Context
• type ContextKey
• type DirInput
  • func (this DirInput) Exclude(pth string, info os.FileInfo) bool
  • func (this DirInput) Find(cb func(file File) error) (err error)
  • func (this DirInput) Finder() (finder Finder)
  • func (this DirInput) GetPrefix() string
  • func (this DirInput) GetTrimPrefix() string
  • func (this DirInput) Include(pth string, info os.FileInfo) bool
  • func (this DirInput) IsRecursive() bool
  • func (this DirInput) PathOf(realPath string) (pth string)
  • func (this DirInput) Setup(ctx context.Context) (err error)
  • func (this *DirInput) SetupTree(ctx context.Context, prefix string) (err error)
• type File
• type FileMatcher
  • func FileMatchGlob(pattern string) (acceptor FileMatcher, err error)
  • func FileMatchRegex(pattern string) (acceptor FileMatcher, err error)
  • func ParseFileMatcher(s string) (fm FileMatcher, err error)
• type FileMatcherFunc
  • func (this FileMatcherFunc) Match(pth string, info os.FileInfo) bool
• type FileMatchers
  • func ParseFileMatchers(items ...string) (include, exclude FileMatchers, err error)
  • func (this FileMatchers) Match(pth string, info os.FileInfo) bool
  • func (this *FileMatchers) Parse(items ...string) (err error)
• type Finder
• type Finders
  • func (this Finders) Find(cb func(file File) error) (err error)
• type Input
• type InputFinder
• type InputFinders
  • func (this InputFinders) Finder() Finder
  • func (this InputFinders) Setup(ctx context.Context) (err error)
• type RealFile
  • func NewRealFile(path, realPath string, info os.FileInfo) *RealFile
  • func (this RealFile) GetPath() string
  • func (this RealFile) Reader() (r io.ReadCloser, err error)
  • func (this *RealFile) String() (s string)

Functions

func GetDirConfigFile

func GetDirConfigFile(ctx context.Context) (name string)

func WithDirConfigFile

func WithDirConfigFile(name string, ctx context.Context) context.Context

Types

type ContextKey

type ContextKey uint8

const (
	LoadDirConfigFile ContextKey = iota
)

type DirInput

type DirInput struct {
	Dir        string
	TrimPrefix string `mapstructure:"strip_prefix" yaml:"strip_prefix"`
	Prefix     string
	Recursive  bool
	Includes   FileMatchers
	Excludes   FileMatchers
	Sources    []DirInput
}

func (DirInput) Exclude

func (this DirInput) Exclude(pth string, info os.FileInfo) bool

func (DirInput) Find

func (this DirInput) Find(cb func(file File) error) (err error)

func (DirInput) Finder

func (this DirInput) Finder() (finder Finder)

func (DirInput) GetPrefix

func (this DirInput) GetPrefix() string

func (DirInput) GetTrimPrefix

func (this DirInput) GetTrimPrefix() string

func (DirInput) Include

func (this DirInput) Include(pth string, info os.FileInfo) bool

func (DirInput) IsRecursive

func (this DirInput) IsRecursive() bool

func (DirInput) PathOf

func (this DirInput) PathOf(realPath string) (pth string)

func (DirInput) Setup

func (this DirInput) Setup(ctx context.Context) (err error)

func (*DirInput) SetupTree

func (this *DirInput) SetupTree(ctx context.Context, prefix string) (err error)

type File

type File interface {
	fmt.Stringer
	os.FileInfo
	GetPath() string
	Reader() (r io.ReadCloser, err error)
}

type FileMatcher

type FileMatcher interface {
	Match(pth string, info os.FileInfo) bool
}

func FileMatchGlob

func FileMatchGlob(pattern string) (acceptor FileMatcher, err error)

func FileMatchRegex

func FileMatchRegex(pattern string) (acceptor FileMatcher, err error)

func ParseFileMatcher

func ParseFileMatcher(s string) (fm FileMatcher, err error)

type FileMatcherFunc

type FileMatcherFunc func(pth string, info os.FileInfo) bool

func (FileMatcherFunc) Match

func (this FileMatcherFunc) Match(pth string, info os.FileInfo) bool

type FileMatchers

type FileMatchers []FileMatcher

func ParseFileMatchers

func ParseFileMatchers(items ...string) (include, exclude FileMatchers, err error)

func (FileMatchers) Match

func (this FileMatchers) Match(pth string, info os.FileInfo) bool

func (*FileMatchers) Parse

func (this *FileMatchers) Parse(items ...string) (err error)

type Finder

type Finder interface {
	Find(cb func(file File) error) (err error)
}

type Finders

type Finders []Finder

func (Finders) Find

func (this Finders) Find(cb func(file File) error) (err error)

type Input

type Input interface {
	InputFinder
	GetTrimPrefix() string
	GetPrefix() string
	IsRecursive() bool
	Include(pth string, info os.FileInfo) bool
	Exclude(pth string, info os.FileInfo) bool
}

type InputFinder

type InputFinder interface {
	Setup(ctx context.Context) (err error)
	Finder() Finder
}

type InputFinders

type InputFinders []InputFinder

func (InputFinders) Finder

func (this InputFinders) Finder() Finder

func (InputFinders) Setup

func (this InputFinders) Setup(ctx context.Context) (err error)

type RealFile

type RealFile struct {
	os.FileInfo
	Path       string
	RealPath   string
	ReaderFunc func() (r io.ReadCloser, err error)
}

func NewRealFile

func NewRealFile(path, realPath string, info os.FileInfo) *RealFile

func (RealFile) GetPath

func (this RealFile) GetPath() string

func (RealFile) Reader

func (this RealFile) Reader() (r io.ReadCloser, err error)

func (*RealFile) String

func (this *RealFile) String() (s string)