index

package

v0.0.0-...-b1b52ee Latest Latest Go to latest Published: Mar 7, 2019 License: MIT Imports: 11 Imported by: 0

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 DatabaseStatistics struct {
	NumberOfFiles int `json:"number_of_files"`
	KeywordCount  int `json:"number_of_keywords"`
}

DatabaseStatistics contains some small statistic numbers from the amount of content in the system

type KeywordResult struct {
	BookID   string
	Filename string
}

KeywordResult is a single result, pointing to a BookID and a Filename inside this book which has the keyword

type Store struct {
	FileName string
	// contains filtered or unexported fields
}

Store is the store for keywords

func NewStore(prefix, ext, f1FragmentPattern string) *Store

NewStore creates a index store

func OldStore(file, f1FragmentPattern string) *Store

OldStore open a already existing index store

func (i *Store) FetchIndex(book *types.Book)

FetchIndex downloads the index file, decodes it and requests it to be added to the store

func (i *Store) GetStatistics() DatabaseStatistics

GetStatistics reads the statistics from the db storage and returns them

func (i *Store) LookupKeyword(keyword string) []KeywordResult

LookupKeyword looks up the keyword in the store, and returns a slice of KeywordResult