Skip to main content

Module index

Module index 

Source
Expand description

The index module in Tantivy contains core components to read and write indexes.

It contains Index and Segment, where a Index consists of one or more Segments.

Structs§

FieldMetadata
FieldMetadata
Index
Search Index
IndexBuilder
IndexBuilder can be used to create an index.
IndexMeta
Meta information about the Index.
IndexSettings
Search Index Settings.
IndexSortByField
Settings to presort the documents in an index
InvertedIndexPlugin
Built-in segment plugin that stores and merges the inverted index.
InvertedIndexPluginWriter
Accumulates and serializes inverted-index data for a segment.
InvertedIndexReader
The inverted index reader is in charge of accessing the inverted index associated with a specific field.
Segment
A segment is a piece of the index.
SegmentId
Uuid identifying a segment.
SegmentMeta
SegmentMeta contains simple meta information about a segment.
SegmentReader
Entry point to access all of the datastructures of the Segment

Enums§

Order
The order to sort by
SegmentComponent
Enum describing each component of a tantivy segment.