walker

Documentation

Index

• type DocumentStore
• type ModuleStore
• type PathStore
• type WalkFunc
• type Walker
  • func NewWalker(fs fs.ReadDirFS, pathStore PathStore, modStore ModuleStore, walkFunc WalkFunc) *Walker
  • func (w *Walker) SetIgnoredDirectoryNames(ignoredDirectoryNames []string)
  • func (w *Walker) SetIgnoredPaths(ignoredPaths []string)
  • func (w *Walker) SetLogger(logger *log.Logger)
  • func (w *Walker) StartWalking(ctx context.Context) error
  • func (w *Walker) Stop()
• type WalkerCollector
  • func NewWalkerCollector() *WalkerCollector
  • func (wc *WalkerCollector) CollectError(err error)
  • func (wc *WalkerCollector) CollectJobId(jobId job.ID)
  • func (wc *WalkerCollector) ErrorOrNil() error
  • func (wc *WalkerCollector) JobIds() job.IDs

Types

type DocumentStore

type DocumentStore interface {
	HasOpenDocuments(dirHandle document.DirHandle) (bool, error)
}

type ModuleStore

type ModuleStore interface {
	AddIfNotExists(dir string) error
}

type PathStore

type PathStore interface {
	AwaitNextDir(ctx context.Context) (context.Context, document.DirHandle, error)
	RemoveDir(dir document.DirHandle) error
}

type WalkFunc

type WalkFunc func(ctx context.Context, modHandle document.DirHandle) (job.IDs, error)

type Walker

type Walker struct {
	Collector *WalkerCollector
	// contains filtered or unexported fields
}

func NewWalker

func NewWalker(fs fs.ReadDirFS, pathStore PathStore, modStore ModuleStore, walkFunc WalkFunc) *Walker

func (*Walker) SetIgnoredDirectoryNames

func (w *Walker) SetIgnoredDirectoryNames(ignoredDirectoryNames []string)

func (*Walker) SetIgnoredPaths

func (w *Walker) SetIgnoredPaths(ignoredPaths []string)

func (*Walker) SetLogger

func (w *Walker) SetLogger(logger *log.Logger)

func (*Walker) StartWalking

func (w *Walker) StartWalking(ctx context.Context) error

func (*Walker) Stop

func (w *Walker) Stop()

type WalkerCollector

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

func NewWalkerCollector

func NewWalkerCollector() *WalkerCollector

func (*WalkerCollector) CollectError

func (wc *WalkerCollector) CollectError(err error)

func (*WalkerCollector) CollectJobId

func (wc *WalkerCollector) CollectJobId(jobId job.ID)

func (*WalkerCollector) ErrorOrNil

func (wc *WalkerCollector) ErrorOrNil() error

func (*WalkerCollector) JobIds

func (wc *WalkerCollector) JobIds() job.IDs