Struct tantivy::IndexReader

source ·

pub struct IndexReader { /* private fields */ }

Expand description

IndexReader is your entry point to read and search the index.

It controls when a new version of the index should be loaded and lends you instances of Searcher for the last loaded version.

IndexReader just wraps an Arc.

Implementations§

source §

impl IndexReader

source

pub fn reload(&self) -> Result<()>

Update searchers so that they reflect the state of the last .commit().

If you set up the ReloadPolicy::OnCommitWithDelay (which is the default) every commit should be rapidly reflected on your IndexReader and you should not need to call reload() at all.

This automatic reload can take 10s of milliseconds to kick in however, and in unit tests it can be nice to deterministically force the reload of searchers.

source

pub fn searcher(&self) -> Searcher

Returns a searcher

This method should be called every single time a search query is performed.

The same searcher must be used for a given query, as it ensures the use of a consistent segment set.

Trait Implementations§

source §

impl Clone for IndexReader

source §

fn clone(&self) -> IndexReader

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source §

impl TryInto<IndexReader> for IndexReaderBuilder

§

type Error = TantivyError

The type returned in the event of a conversion error.

source §

fn try_into(self) -> Result<IndexReader>

Performs the conversion.

Auto Trait Implementations§

§

impl !UnwindSafe for IndexReader

Blanket Implementations§

source §

impl<T> Any for T
where T: 'static + ?Sized,

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

impl<T> Borrow<T> for T
where T: ?Sized,

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source §

impl<T> Downcast for T
where T: Any,

source §

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>

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)

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)

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
where T: Any + Send + Sync,

source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

source §