Struct BTreeIndex 

pub struct BTreeIndex { /* private fields */ }

B-tree index implementation

Implementations

impl BTreeIndex

pub fn new(name: String, config: &IndexConfig) -> Self

Trait Implementations

impl Index for BTreeIndex

fn name(&self) -> &str

Get the index name

fn index_type(&self) -> IndexType

Get the index type

fn insert<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, value: &'life1 str, document_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), IndexError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Insert a value with associated document ID

fn remove<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, value: &'life1 str, document_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), IndexError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Remove a value-document association

fn get<'life0, 'life1, 'async_trait>( &'life0 self, value: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, IndexError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get document IDs for a value

fn values<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, IndexError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get all values in the index

fn stats<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<IndexStats, IndexError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get index statistics

fn clear<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), IndexError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clear the index