Skip to main content

SegmentBuilder

Struct SegmentBuilder 

Source
pub struct SegmentBuilder { /* private fields */ }
Expand description

Builds a segment from analyzed documents.

Usage:

  1. Create with new(segment_id, &schema)
  2. Call add_document() for each document
  3. Call build() to produce the segment bytes

Implementations§

Source§

impl SegmentBuilder

Source

pub fn new(segment_id: SegmentId, schema: &Mapping) -> Self

Source

pub fn add_document( &mut self, analyzed_fields: &[(FieldId, Vec<Token>)], source: &[u8], )

Add a document with its analyzed fields and raw source JSON.

analyzed_fields contains (field_id, tokens) for each indexed field. Keyword fields should have a single token with the exact value. source is the original JSON bytes stored for _source retrieval.

Source

pub fn mark_parent(&mut self)

Mark the most recently added doc as a parent (not nested).

Source

pub fn mark_nested(&mut self)

Mark the current doc as a nested (hidden) doc.

Source

pub fn add_geo_point(&mut self, field_id: FieldId, point: GeoPoint)

Add a geo point for a geo_point field.

Source

pub fn add_geo_shape(&mut self, field_id: FieldId, geom: &Geometry<f64>)

Add a geo shape for a geo_shape field.

Source

pub fn add_column_value(&mut self, field_id: FieldId, value: ColumnValue)

Add a column value for a doc_values field.

Source

pub fn doc_count(&self) -> u32

Number of documents added so far.

Source

pub fn segment_id(&self) -> SegmentId

The segment id assigned to this builder. Used by [IndexWriter::add] to stamp the current doc’s (segment_id, local_doc_id) pair into the global HNSW resolver before add_document is called.

Source

pub fn is_empty(&self) -> bool

Is the buffer empty?

Source

pub fn build(self) -> Vec<u8>

Build the complete segment bytes.

Returns the serialized segment including header, inverted index, norms, and document store.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool