search

package

v0.10.0 Latest Latest Go to latest Published: Feb 11, 2017 License: BSD-3-Clause Imports: 6 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

FullTextIndex indexes a given set if repository items and enables a full-text search on these items.

func (index *FullTextIndex) Search(keywords string, maxiumNumberOfResults int) []Result

Search scans the fulltext index for the given keywords and returns any matching search results.

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

ItemSearch creates a fulltext index for given set of repository items and provides the ability to search over this index.

func NewItemSearch(logger logger.Logger, items []*model.Item) *ItemSearch

NewItemSearch creates a new repository item searcher.

func (itemSearch *ItemSearch) Search(keywords string, maxiumNumberOfResults int) []Result

Search returns a set of Result models that match specified keywords.

type Result struct {
	Route route.Route

	Number     int
	Score      int64
	StoreValue string
}

Result is the model returned by the fulltext index's Search function.