searcher

Documentation

Index

• type Searcher
  • func New(vcsDir string, repo *config.Repo) (*Searcher, error)
  • func NewFromExisting(vcsDir string, repo *config.Repo) (*Searcher, error)
  • func (s *Searcher) GetExcludedFiles() string
  • func (s *Searcher) Search(pat string, opt *index.SearchOptions) (*index.SearchResponse, error)

Types

type Searcher

type Searcher struct {
	Repo *config.Repo
	// contains filtered or unexported fields
}

func New

func New(vcsDir string, repo *config.Repo) (*Searcher, error)

Creates a new Searcher that is available for searches as soon as this returns. This will pull or clone the target repo and start watching the repo for changes.

func NewFromExisting

func NewFromExisting(vcsDir string, repo *config.Repo) (*Searcher, error)

Creates a new Searcher for the vcsDir but avoids any remote vcs operations. This requires that an existing vcsDir be available in the data directory. This is intended for debugging and testing only. This will not start a watcher to monitor the remote repo for changes.

func (*Searcher) GetExcludedFiles

func (s *Searcher) GetExcludedFiles() string

func (*Searcher) Search

func (s *Searcher) Search(pat string, opt *index.SearchOptions) (*index.SearchResponse, error)