Module documents

Structs

DocumentsBatchBuilder

The DocumentsBatchBuilder provides a way to build a documents batch in the intermediary format used by milli.

DocumentsBatchCursor

A forward cursor over the documents in a DocumentsBatchReader.

DocumentsBatchIndex

A bidirectional map that links field ids to their name in a document batch.

DocumentsBatchReader

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

EnrichedDocument

EnrichedDocumentsBatchCursor

EnrichedDocumentsBatchReader

The EnrichedDocumentsBatchReader provides a way to iterate over documents that have been created with a DocumentsBatchWriter and, for the enriched data, a simple grenad::Reader<File>.

Enums

DocumentIdExtractionError

DocumentsBatchCursorError

The possible error thrown by the DocumentsBatchCursor when iterating on the documents.

Error

PrimaryKey

A type that represent the type of primary key that has been set for this index, a classic flat one or a nested one.

Constants

DEFAULT_PRIMARY_KEY

The default primary that is used when not specified.

Traits

FieldIdMapper

Trait for objects that can map the name of a field to its FieldId.

Functions

documents_batch_reader_from_objects

mmap_from_objects

objects_from_json_value

obkv_to_object

Helper function to convert an obkv reader into a JSON object.

validate_document_id_str

validate_document_id_value