dirscanner

Documentation

Index

• type DirScanner
  • func New(fs fs.FS, processors []Processor, numThreads int) *DirScanner
  • func (s *DirScanner) Scan(ctx context.Context) error
• type Processor

Types

type DirScanner

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

DirScanner encapsulates the logic for scanning a directory hierarchy and generating FileUpload objects from the files within.

func New

func New(fs fs.FS, processors []Processor, numThreads int) *DirScanner

New instantiates a new directory scanner instance with the provided options.

func (*DirScanner) Scan

func (s *DirScanner) Scan(ctx context.Context) error

Scan traverses the filesystem and runs all registered processors on all regular files.

type Processor

type Processor interface {
	Process(ctx context.Context, path string) (*processor.File, error)
}

Processor is the interface required to handle file uploads produced by the DirScanner instance.