# Packages
Package segment is a generated GoMock package.
# Functions
AllowPartialUpdates permits an index to continue indexing documents in a batch even if it encountered an error inserting a prior document.
CompileRegex compiles the provided regexp into an object that can be used to query the various segment implementations.
DotStarCompiledRegex returns a regexp which matches ".*".
IsBatchPartialError returns a bool indicating whether err is a BatchPartialError or not.
NewBatch returns a Batch of documents.
NewBatchMatcher returns a new BatchMatcher.
NewBatchPartialError returns a new BatchPartialError.
NewIDDocIterator returns a new NewIDDocIterator.
NewIterator returns a new Iterator.
NewMockDocRetriever creates a new mock instance.
NewMockMetadataRetriever creates a new mock instance.
NewMockReader creates a new mock instance.
SetRegexpCacheOptions sets the regex cache options, size zero disables cache.
# Variables
ErrDocNotFound is the error returned when there is no document for a given postings ID.
ErrDuplicateID is the error returned when a batch contains duplicate IDs.
# Structs
Batch represents a batch of documents that should be inserted into the index.
BatchError is an error that occurred for a document being inserted.
BatchPartialError indicates an error was encountered inserting some documents in a batch.
CompiledRegex is a collection of regexp compiled structs to allow amortisation of regexp construction costs.
MockDocRetriever is a mock of DocRetriever interface.
MockDocRetrieverMockRecorder is the mock recorder for MockDocRetriever.
MockMetadataRetriever is a mock of MetadataRetriever interface.
MockMetadataRetrieverMockRecorder is the mock recorder for MockMetadataRetriever.
MockReader is a mock of Reader interface.
MockReaderMockRecorder is the mock recorder for MockReader.
RegexpCacheOptions is a set of regexp cache options.
# Interfaces
BatchMatcher matches a `Batch`.
BatchOption is an option for a Batch.
DocRetriever returns the document associated with a postings ID.
IDDocIterator is an extented documents Iterator which can also return the postings ID of the current document.
IDIterator is a document ID iterator.
Index is a collection of searchable documents.
MetadataRetriever returns the metadata associated with a postings ID.
Readable provides a point-in-time accessor to the documents in an index.
Reader provides a point-in-time accessor to the documents in an index.
Writer is used to insert documents into an index.
# Type aliases
Readers is a slice of Reader.