Struct elasticlunr::IndexBuilder

pub struct IndexBuilder { /* private fields */ }

A builder for an Index with custom parameters.

Example

let mut index = IndexBuilder::new()
    .save_docs(false)
    .add_fields(&["title", "subtitle", "body"])
    .set_ref("doc_id")
    .build();
index.add_doc("doc_a", &["Chapter 1", "Welcome to Copenhagen", "..."]);

Implementations

impl IndexBuilder

pub fn new() -> Self

pub fn with_language(language: Box<dyn Language>) -> Self

pub fn save_docs(self, save: bool) -> Self

Set whether or not documents should be saved in the Index’s document store.

pub fn add_field(self, field: &str) -> Self

Add a document field to the Index.

Panics

Panics if a field with the name already exists.

pub fn add_field_with_tokenizer(
    self,
    field: &str,
    tokenizer: Box<dyn Fn(&str) -> Vec<String>>
) -> Self

Add a document field to the Index, with a custom tokenizer for that field.

Panics

Panics if a field with the name already exists.

pub fn add_fields<I>(self, fields: I) -> Self where
    I: IntoIterator,
    I::Item: AsRef<str>, 

Add the document fields to the Index.

Panics

Panics if two fields have the same name.

pub fn set_ref(self, ref_field: &str) -> Self

Set the key used to store the document reference field.

pub fn build(self) -> Index

Build an Index from this builder.

Trait Implementations

impl Default for IndexBuilder

fn default() -> Self

Returns the “default value” for a type.