Struct SearchEngine

pub struct SearchEngine<P> { /* private fields */ }

A SearchEngine is a wrapper around a collection of search indices that can process complex queries involving multiple indices.

It can also create queries from strings that are tailored to the existing indices.

Example

A complete example can be found on the front page of this crate.

Implementations

impl<P: Eq + Hash + Clone> SearchEngine<P>

pub fn new() -> Self

Creates a new SearchEngine.

Example

use attribute_search_engine::SearchEngine;

let engine = SearchEngine::<usize>::new();

pub fn add_index<T: SearchIndex<P> + 'static>(&mut self, name: &str, index: T)

Add a new index to this search engine.

Example

use attribute_search_engine::{SearchEngine, SearchIndexHashMap};

let mut index = SearchIndexHashMap::<_, String>::new();

// Fill index here...

let mut engine = SearchEngine::<usize>::new();
engine.add_index("attribute", index);

pub fn search(&self, query: &Query) -> Result<HashSet<P>>

Run a query on the search engine.

The result is a HashSet of all row ids / primary ids with rows that matched the query.

pub fn query_from_str(&self, query_str: &str) -> Result<Query>

Trait Implementations

impl<P: Eq + Hash + Clone> Default for SearchEngine<P>

fn default() -> Self

Returns the “default value” for a type.