Struct tantivy::fastfield::BytesFastFieldWriter

pub struct BytesFastFieldWriter { /* fields omitted */ }

Writer for byte array (as in, any number of bytes per document) fast fields

This BytesFastFieldWriter is only useful for advanced user. The normal way to get your associated bytes in your index is to

• declare your field with fast set to Cardinality::SingleValue in your schema
• add your document simply by calling .add_document(...) with associating bytes to the field.

The BytesFastFieldWriter can be acquired from the fast field writer by calling .get_bytes_writer(...).

Once acquired, writing is done by calling .add_document_val(&[u8]) once per document, even if there are no bytes associated to it.

Implementations

impl BytesFastFieldWriter

pub fn new(field: Field) -> Self

Creates a new BytesFastFieldWriter

pub fn mem_usage(&self) -> usize

The memory used (inclusive childs)

pub fn field(&self) -> Field

Access the field associated to the BytesFastFieldWriter

pub fn add_document(&mut self, doc: &Document)

Shift to the next document and add all of the matching field values present in the document.

pub fn add_document_val(&mut self, val: &[u8]) -> DocId

Register the bytes associated to a document.

The method returns the DocId of the document that was just written.

pub fn serialize(
    &self,
    serializer: &mut CompositeFastFieldSerializer,
    doc_id_map: Option<&DocIdMapping>
) -> Result<()>

Serializes the fast field values by pushing them to the FastFieldSerializer.