Struct tantivy::store::StoreReader

pub struct StoreReader { /* private fields */ }

Reads document off tantivy’s Store

Implementations

impl StoreReader

pub fn open(store_file: FileSlice) -> Result<StoreReader>

Opens a store reader

pub fn get(&self, doc_id: DocId) -> Result<Document>

Reads a given document.

Calling .get(doc) is relatively costly as it requires decompressing a compressed block. The store utilizes a LRU cache, so accessing docs from the same compressed block should be faster. For that reason a store reader should be kept and reused.

It should not be called to score documents for instance.

pub fn get_document_bytes(&self, doc_id: DocId) -> Result<OwnedBytes>

Reads raw bytes of a given document. Returns RawDocument, which contains the block of a document and its start and end position within the block.

Calling .get(doc) is relatively costly as it requires decompressing a compressed block. The store utilizes a LRU cache, so accessing docs from the same compressed block should be faster. For that reason a store reader should be kept and reused.

pub fn iter<'a: 'b, 'b>(
    &'b self,
    alive_bitset: Option<&'a AliveBitSet>
) -> impl Iterator<Item = Result<Document>> + 'b

Iterator over all Documents in their order as they are stored in the doc store. Use this, if you want to extract all Documents from the doc store. The alive_bitset has to be forwarded from the SegmentReader or the results maybe wrong.

pub fn space_usage(&self) -> StoreSpaceUsage

Summarize total space usage of this store reader.