Struct pallet::search::IndexBuilder

pub struct IndexBuilder<T> { /* fields omitted */ }

Builder for an Index

Implementations

impl<T> IndexBuilder<T>

pub fn with_index_dir<I: Into<PathBuf>>(mut self: Self, index_dir: I) -> Self

Use the given directory (must exist) for the tantivy::Index.

pub fn with_writer_accessor<F>(mut self: Self, writer_accessor: F) -> Self where
    F: Fn(&Index) -> Result<IndexWriter> + Send + Sync + 'static, 

Define a custom way to get the tantivy::IndexWriter.

By default will use tantivy_index.writer(128_000_000).

pub fn with_config<F>(mut self: Self, config: F) -> Self where
    F: Fn(&mut Index) -> Result<()> + 'static, 

Custom configuration for the tantivy::Index.

By default will use tantivy_index.set_default_multithread_executor()?.

pub fn with_id_field_name<I: Into<String>>(
    mut self: Self,
    id_field_name: I
) -> Self

Set the field name to be used for the datastore id.

By default will use __id__.

pub fn with_fields_builder<F>(mut self: Self, fields_builder: F) -> Self where
    F: Fn(&mut SchemaBuilder) -> Result<T> + 'static, 

Handler that adds fields to a schema, and returns them in the fields container

pub fn with_default_search_fields_builder<F>(
    mut self: Self,
    default_search_fields_builder: F
) -> Self where
    F: Fn(&T) -> Vec<Field> + 'static, 

Given the fields container, return fields that should be used in default search.

pub fn finish(self) -> Result<Index<T>>

Convert into finished Index

Trait Implementations

impl<T> Default for IndexBuilder<T>

fn default() -> Self

Returns the "default value" for a type.