Struct Index

pub struct Index { /* private fields */ }

An elasticlunr search index.

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"]);
index.add_doc("1", &["this is a title", "this is body text"]);

Panics

Panics if a field with the name already exists.

pub fn with_language<I>(lang: Box<dyn Language>, fields: I) -> Self

where I: IntoIterator, I::Item: AsRef<str>,

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

Example

use elasticlunr::{Index, lang::English};
let mut index = Index::with_language(Box::new(English::new()), &["title", "body"]);
index.add_doc("1", &["this is a title", "this is body text"]);

Panics

Panics if a field with the name already exists.

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 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 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.