Struct TantivyFulltextIndexCreator

pub struct TantivyFulltextIndexCreator {
    writer: Option<IndexWriter>,
    text_field: Field,
    rowid_field: Field,
    max_rowid: u64,
    path: PathBuf,
    config: Config,
}

TantivyFulltextIndexCreator is a fulltext index creator using tantivy.

Fields

writer: Option<IndexWriter>

The tantivy index writer.

text_field: Field

The field for the text.

rowid_field: Field

The field for the row id.

max_rowid: u64

The current max row id.

path: PathBuf

The directory path in filesystem to store the index.

config: Config

The configuration of the fulltext index.

Implementations

impl TantivyFulltextIndexCreator

pub async fn new( path: impl AsRef<Path>, config: Config, memory_limit: usize, ) -> Result<Self>

Creates a new TantivyFulltextIndexCreator.

The path is the directory path in filesystem to store the index.

fn sanitize_memory_limit(memory_limit: usize) -> usize

Trait Implementations

impl FulltextIndexCreator for TantivyFulltextIndexCreator

fn push_text<'life0, 'life1, 'async_trait>( &'life0 mut self, text: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Pushes a text to the index.

fn finish<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, puffin_writer: &'life1 mut (impl 'async_trait + PuffinWriter + Send), blob_key: &'life2 str, put_options: PutOptions, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

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

Finalizes the creation of the index.

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

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

Aborts the creation of the index.

fn memory_usage(&self) -> usize

Returns the memory usage in bytes during the creation of the index.