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§
- Field
Metadata - FieldMetadata
- Index
- Search Index
- Index
Builder - IndexBuilder can be used to create an index.
- Index
Meta - Meta information about the
Index. - Index
Settings - Search Index Settings.
- Index
Sort ByField - Settings to presort the documents in an index
- Inverted
Index Plugin - Built-in segment plugin that stores and merges the inverted index.
- Inverted
Index Plugin Writer - Accumulates and serializes inverted-index data for a segment.
- Inverted
Index Reader - 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.
- Segment
Id - Uuid identifying a segment.
- Segment
Meta SegmentMetacontains simple meta information about a segment.- Segment
Reader - Entry point to access all of the datastructures of the
Segment
Enums§
- Order
- The order to sort by
- Segment
Component - Enum describing each component of a tantivy segment.