query

Documentation

Overview

Package query implements search query parsing and matching.

Index

• type Match
• type Query
  • func Parse(queryStr string) Query
  • func (q Query) FindAllIndex(text string) []Match
  • func (q Query) Match(pathStr string, text []byte) bool
  • func (q Query) Score(pathStr string, text []byte) float64

Types

type Match

type Match [2]int

Match is an array of [start, end] byte indexes for a match.

type Query

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

Query is a search query.

func Parse

func Parse(queryStr string) Query

Parse parses a search query string.

func (Query) FindAllIndex

func (q Query) FindAllIndex(text string) []Match

FindAllIndex returns a slice of all query match indexes in the text.

func (Query) Match

func (q Query) Match(pathStr string, text []byte) bool

Match reports whether the path or text contains at least 1 match of the query.

func (Query) Score

func (q Query) Score(pathStr string, text []byte) float64

Score scores the query match against the path and text.