Struct DocumentsBatchBuilder

pub struct DocumentsBatchBuilder<W> { /* private fields */ }

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

The writer used by the DocumentsBatchBuilder can be read using a DocumentsBatchReader to iterate over the documents.

example:

use serde_json::json;
use milli_core::documents::DocumentsBatchBuilder;

let json = json!({ "id": 1, "name": "foo" });

let mut builder = DocumentsBatchBuilder::new(Vec::new());
builder.append_json_object(json.as_object().unwrap()).unwrap();
let _vector = builder.into_inner().unwrap();

Implementations

impl<W: Write> DocumentsBatchBuilder<W>

pub fn new(writer: W) -> DocumentsBatchBuilder<W>

pub fn documents_count(&self) -> u32

Returns the number of documents inserted into this builder.

pub fn append_json_object(&mut self, object: &Object) -> Result<()>

Appends a new JSON object into the batch and updates the DocumentsBatchIndex accordingly.

pub fn append_json_array<R: Read>(&mut self, reader: R) -> Result<(), Error>

Appends a new JSON array of objects into the batch and updates the DocumentsBatchIndex accordingly.

pub fn into_inner(self) -> Result<W>

Flushes the content on disk and stores the final version of the DocumentsBatchIndex.