index

type Index ¶

type Index struct {
	Verbose bool
	// contains filtered or unexported fields
}

An Index implements read-only access to a trigram index.

func Open(file string) (*Index, error)

func (ix *Index) Name(fileid uint32) string

func (ix *Index) NameBytes(fileid uint32) []byte

func (ix *Index) Paths() []string

func (ix *Index) PostingAnd(list []uint32, trigram uint32) []uint32

func (ix *Index) PostingList(trigram uint32) []uint32

func (ix *Index) PostingOr(list []uint32, trigram uint32) []uint32

func (ix *Index) PostingQuery(q *Query) []uint32

type IndexWriter ¶

type IndexWriter interface {
	AddPaths(paths []string)
	AddFile(name string)
	Add(name string, f io.Reader)
	DataBytes() int64
	IndexBytes() uint32
	Flush()
}

type Query ¶

type Query struct {
	Op      QueryOp
	Trigram []string
	Sub     []*Query
}

A Query is a matching machine, like a regular expression, that matches some text and not other text. When we compute a Query from a regexp, the Query is a conservative version of the regexp: it matches everything the regexp would match, and probably quite a bit more. We can then filter target files by whether they match the Query (using a trigram index) before running the comparatively more expensive regexp machinery.

func RegexpQuery(re *syntax.Regexp) *Query

func (q *Query) String() string

type QueryOp ¶

type QueryOp int

const (
	QAll  QueryOp = iota // Everything matches
	QNone                // Nothing matches
	QAnd                 // All in Sub and Trigram must match
	QOr                  // At least one in Sub or Trigram must match
)