pub struct SearchIndex { /* private fields */ }Expand description
Full-text search index for symbols, backed by Tantivy.
Indexes symbol metadata across multiple text fields and supports
filtering by repository. The index is stored on disk at the path
provided to SearchIndex::open.
Implementations§
Source§impl SearchIndex
impl SearchIndex
Sourcepub fn open(path: &Path) -> Result<Self>
pub fn open(path: &Path) -> Result<Self>
Open or create a Tantivy index at the given directory path.
Defines the schema with the following fields:
symbol_id— stored string (UUID)repo_id— indexed string (not tokenized) for filteringname— tokenized text fieldqualified_name— tokenized text fieldsignature— tokenized text fielddoc_comment— tokenized text fieldfile_path— tokenized text fieldkind— indexed string (not tokenized)
Sourcepub fn index_symbol(&mut self, repo_id: RepoId, sym: &Symbol) -> Result<()>
pub fn index_symbol(&mut self, repo_id: RepoId, sym: &Symbol) -> Result<()>
Add a symbol document to the index.
Sourcepub fn remove_symbol(&mut self, symbol_id: SymbolId) -> Result<()>
pub fn remove_symbol(&mut self, symbol_id: SymbolId) -> Result<()>
Delete a document by symbol_id.
Sourcepub fn delete_by_repo(&mut self, repo_id: RepoId) -> Result<()>
pub fn delete_by_repo(&mut self, repo_id: RepoId) -> Result<()>
Delete all documents belonging to a repository.
Note: This only stages the deletion. You must call [commit] afterwards
for the deletion to be persisted and visible to readers.
Auto Trait Implementations§
impl Freeze for SearchIndex
impl !RefUnwindSafe for SearchIndex
impl Send for SearchIndex
impl Sync for SearchIndex
impl Unpin for SearchIndex
impl UnsafeUnpin for SearchIndex
impl !UnwindSafe for SearchIndex
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more