Struct elasticlunr::Index

pub struct Index {
    pub fields: Vec<String>,
    pub pipeline: Pipeline,
    pub ref_field: String,
    pub version: &'static str,
    pub document_store: DocumentStore,
    // some fields omitted
}

An elasticlunr search index.

Fields

fields: Vec<String>

pipeline: Pipeline

ref_field: String

version: &'static str

document_store: DocumentStore

Implementations

impl Index

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

Create a new index with the provided fields.

Example

let mut index = Index::new(&["title", "body", "breadcrumbs"]);
index.add_doc("1", &["How to Foo", "First, you need to `bar`.", "Chapter 1 > How to Foo"]);

Panics

Panics if multiple given fields are identical.

pub fn with_language<I>(lang: Language, fields: I) -> Self where
    I: IntoIterator,
    I::Item: AsRef<str>, 

Create a new index with the provided fields for the given Language.

Example

let mut index = Index::with_language(Language::English, &["title", "body"]);
index.add_doc("1", &["this is a title", "this is body text"]);

Panics

Panics if multiple given fields are identical.

pub fn add_doc<I>(&mut self, doc_ref: &str, data: I) where
    I: IntoIterator,
    I::Item: AsRef<str>, 

Add the data from a document to the index.

NOTE: The elements of data should be provided in the same order as the fields used to create the index.

Example

let mut index = Index::new(&["title", "body"]);
index.add_doc("1", &["this is a title", "this is body text"]);

pub fn add_doc_with_tokenizer<I>(
    &mut self,
    doc_ref: &str,
    data: I,
    tokenizer: TokenizerFn
) where
    I: IntoIterator,
    I::Item: AsRef<str>, 

Add the data from a document to the index.

NOTE: The elements of data should be provided in the same order as the fields used to create the index.

Example

fn css_tokenizer(text: &str) -> Vec<String> {
    text.split(|c: char| c.is_whitespace())
        .filter(|s| !s.is_empty())
        .map(|s| s.trim().to_lowercase())
        .collect()
}
let mut index = Index::new(&["title", "body"]);
index.add_doc_with_tokenizer("1", &["this is a title", "this is body text"], css_tokenizer);

pub fn add_doc_with_tokenizers<I, T>(
    &mut self,
    doc_ref: &str,
    data: I,
    tokenizers: T
) where
    I: IntoIterator,
    I::Item: AsRef<str>,
    T: IntoIterator<Item = TokenizerFn>, 

Add the data from a document to the index.

NOTE: The elements of data and tokenizers should be provided in the same order as the fields used to create the index.

Example

use elasticlunr::pipeline::{tokenize, TokenizerFn};
fn css_tokenizer(text: &str) -> Vec<String> {
    text.split(|c: char| c.is_whitespace())
        .filter(|s| !s.is_empty())
        .map(|s| s.trim().to_lowercase())
        .collect()
}
let mut index = Index::new(&["title", "body"]);
let tokenizers: Vec<TokenizerFn> = vec![tokenize, css_tokenizer];
index.add_doc_with_tokenizers("1", &["this is a title", "this is body text"], tokenizers);

pub fn get_fields(&self) -> &[String]

pub fn to_json_pretty(&self) -> String

Returns the index, serialized to pretty-printed JSON.

pub fn to_json(&self) -> String

Returns the index, serialized to JSON.

Trait Implementations

impl Debug for Index

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize<'static> for Index

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'static>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Index

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.