Struct SearchIndexPrefixTree

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

SearchIndexPrefixTree is a index backed by a prefix tree that can match Exact and Prefix queries. It can only store String attribute values.

Example

use attribute_search_engine::{SearchIndex, SearchIndexPrefixTree};
use std::collections::HashSet;
use attribute_search_engine::Query;

let mut index_firstname = SearchIndexPrefixTree::<usize>::new();
index_firstname.insert(0, "Alex".into());
index_firstname.insert(1, "Alexander".into());
index_firstname.insert(2, "Andrea".into());
index_firstname.insert(3, "Ben".into());

let result = index_firstname.search(&Query::Exact("<unused>".into(), "Alex".into()));
assert_eq!(result, Ok(HashSet::from_iter(vec![0])));

let result = index_firstname.search(&Query::Prefix("<unused>".into(), "Alex".into()));
assert_eq!(result, Ok(HashSet::from_iter(vec![0, 1])));

Implementations

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

pub fn new() -> Self

Creates a new SearchIndexPrefixTree.

Example

use attribute_search_engine::SearchIndexPrefixTree;

let index = SearchIndexPrefixTree::<usize>::new();

pub fn insert(&mut self, primary_id: P, attribute_value: String)

Insert a new entry in the index.

Example

use attribute_search_engine::SearchIndexPrefixTree;

let mut index = SearchIndexPrefixTree::<usize>::new();

// You insert an entry by giving a row / primary id and an attribute value:
index.insert(123, "Hello".into());
// The same row / primary id can have multiple attributes assigned:
index.insert(123, "World".into());
// Add as much entries as you want for as many rows you want:
index.insert(124, "Rust".into());

Trait Implementations

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

fn default() -> Self

Returns the “default value” for a type.

impl<P: Eq + Hash + Clone> SearchIndex<P> for SearchIndexPrefixTree<P>

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

Perform a search on an index.

fn supported_queries(&self) -> SupportedQueries

Returns which queries are directly supported by an index.