The highest tagged major version is
Documentation
¶
Overview ¶
Package index provides interfaces for indexing ebooks metadata and retrieving this metadata back from the index. Currently, there is only one implementation to those interfaces, using Bleve.
Index ¶
- func AddMappings(indexMapping *mapping.IndexMappingImpl)
- type BleveIndexer
- func (b *BleveIndexer) AddFile(file string) error
- func (b *BleveIndexer) AddLibrary(fs afero.Fs, batchSize int) error
- func (b *BleveIndexer) Close() error
- func (b *BleveIndexer) Count() (uint64, error)
- func (b *BleveIndexer) RemoveFile(file string) error
- func (b *BleveIndexer) Search(keywords string, page, resultsPerPage int) (*Result, error)
- type Reader
- type ReaderMock
- type Result
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddMappings ¶
func AddMappings(indexMapping *mapping.IndexMappingImpl)
Types ¶
type BleveIndexer ¶
type BleveIndexer struct {
// contains filtered or unexported fields
}
func (*BleveIndexer) AddFile ¶
func (b *BleveIndexer) AddFile(file string) error
AddFile adds a file to the index
func (*BleveIndexer) AddLibrary ¶
func (b *BleveIndexer) AddLibrary(fs afero.Fs, batchSize int) error
AddLibrary scans <libraryPath> for books and adds them to the index in batches of <bathSize>
func (*BleveIndexer) Count ¶
func (b *BleveIndexer) Count() (uint64, error)
Count returns the number of indexed books
func (*BleveIndexer) RemoveFile ¶
func (b *BleveIndexer) RemoveFile(file string) error
RemoveFile removes a file from the index
type Reader ¶
type Reader interface {
Search(keywords string, page, resultsPerPage int) (*Result, error)
Count() (uint64, error)
Close() error
}
Reader defines a set of reading operations over an index
type ReaderMock ¶
type ReaderMock struct {
SearchFake func(keywords string, page, resultsPerPage int) (*Result, error)
CountFake func() (uint64, error)
CloseFake func() error
}
ReaderMock implements the Reader interface with a mockable struct. Just assign to each *Fake property the function you want to execute
func NewReaderMock ¶
func NewReaderMock() *ReaderMock
NewReaderMock returns a new instance of ReaderMock
func (*ReaderMock) Close ¶
func (r *ReaderMock) Close() error
Close runs the faked close method contained in the instance
func (*ReaderMock) Count ¶
func (r *ReaderMock) Count() (uint64, error)
Count runs the faked count method contained in the instance
Source Files