Struct DocumentsBatchReader

pub struct DocumentsBatchReader<R> { /* private fields */ }

The DocumentsBatchReader provides a way to iterate over documents that have been created with a DocumentsBatchWriter.

The documents are returned in the form of obkv::Reader where each field is identified with a FieldId. The mapping between the field ids and the field names is done thanks to the index.

Implementations

impl<R: Read + Seek> DocumentsBatchReader<R>

pub fn new( cursor: DocumentsBatchCursor<R>, fields_index: DocumentsBatchIndex, ) -> Self

pub fn from_reader(reader: R) -> Result<Self, Error>

Construct a DocumentsReader from a reader.

It first retrieves the index, then moves to the first document. Use the into_cursor method to iterator over the documents, from the first to the last.

pub fn documents_count(&self) -> u32

pub fn is_empty(&self) -> bool

pub fn documents_batch_index(&self) -> &DocumentsBatchIndex

pub fn into_cursor_and_fields_index( self, ) -> (DocumentsBatchCursor<R>, DocumentsBatchIndex)

This method returns a forward cursor over the documents.