memory

Documentation

Index

• Variables
• type TextIndex
  • func DecodeTextIndex(r io.Reader) (*TextIndex, error)
  • func NewTextIndex() *TextIndex
  • func (ti *TextIndex) AppendBytes(b []byte, docID ...int) error
  • func (ti *TextIndex) AppendString(text string, docID ...int) error
  • func (ti *TextIndex) Encode(w io.Writer) error
  • func (ti *TextIndex) Search(query *search.QueryTerm) (*search.Matches, error)
• type TextQuery
  • func NewTextQuery(q *search.QueryTerm) *TextQuery
  • func NewTextQueryFromString(query string) (*TextQuery, error)
  • func (tq *TextQuery) AppendString(text string, docID int) error
  • func (tq *TextQuery) Highlight(text string, docID int) (string, bool)
  • func (tq *TextQuery) PerformSearch() (bool, error)
  • func (tq *TextQuery) Reset()
  • func (tq *TextQuery) SetTextIndex(ti *TextIndex)

Variables

var (
	ErrSearchNoMatch = errors.New("the search query does not match the index")
)

Types

type TextIndex

type TextIndex struct {
	Terms map[string]*search.Vectors

	DocCount int
	Docs     map[int]bool
	// contains filtered or unexported fields
}

TestIndex is a single document full-text index. This means that all data you append to it will have its position incremented and appends to the known state. It is not replaced. To reset the index to an empty state you have to call the reset method.

func DecodeTextIndex

func DecodeTextIndex(r io.Reader) (*TextIndex, error)

func NewTextIndex

func NewTextIndex() *TextIndex

func (*TextIndex) AppendBytes

func (ti *TextIndex) AppendBytes(b []byte, docID ...int) error

AppendBytes extract words from bytes and updates the TextIndex.

func (*TextIndex) AppendString

func (ti *TextIndex) AppendString(text string, docID ...int) error

AppendString extract words from bytes and updates the TextIndex.

func (*TextIndex) Encode

func (ti *TextIndex) Encode(w io.Writer) error

func (*TextIndex) Search

func (ti *TextIndex) Search(query *search.QueryTerm) (*search.Matches, error)

type TextQuery

type TextQuery struct {
	Hits         *search.Matches
	EmStartTag   string
	EmStyleClass string
	// contains filtered or unexported fields
}

func NewTextQuery

func NewTextQuery(q *search.QueryTerm) *TextQuery

func NewTextQueryFromString

func NewTextQueryFromString(query string) (*TextQuery, error)

func (*TextQuery) AppendString

func (tq *TextQuery) AppendString(text string, docID int) error

func (*TextQuery) Highlight

func (tq *TextQuery) Highlight(text string, docID int) (string, bool)

func (*TextQuery) PerformSearch

func (tq *TextQuery) PerformSearch() (bool, error)

func (*TextQuery) Reset

func (tq *TextQuery) Reset()

func (*TextQuery) SetTextIndex

func (tq *TextQuery) SetTextIndex(ti *TextIndex)