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.
Clone
does not clone the different pool of searcher. IndexReader
just wraps and Arc
.
Implementations
sourceimpl IndexReader
impl IndexReader
sourcepub fn reload(&self) -> Result<()>
pub fn reload(&self) -> Result<()>
Update searchers so that they reflect the state of the last
.commit()
.
If you set up the OnCommit
ReloadPolicy
(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.
sourcepub fn searcher(&self) -> LeasedItem<Searcher>
pub fn searcher(&self) -> LeasedItem<Searcher>
Returns a searcher
This method should be called every single time a search
query is performed.
The searchers are taken from a pool of num_searchers
searchers.
If no searcher is available
this may block.
The same searcher must be used for a given query, as it ensures the use of a consistent segment set.
Trait Implementations
sourceimpl Clone for IndexReader
impl Clone for IndexReader
sourcefn clone(&self) -> IndexReader
fn clone(&self) -> IndexReader
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl TryInto<IndexReader> for IndexReaderBuilder
impl TryInto<IndexReader> for IndexReaderBuilder
type Error = TantivyError
type Error = TantivyError
The type returned in the event of a conversion error.
sourcefn try_into(self) -> Result<IndexReader>
fn try_into(self) -> Result<IndexReader>
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for IndexReader
impl Send for IndexReader
impl Sync for IndexReader
impl Unpin for IndexReader
impl !UnwindSafe for IndexReader
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn 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. Read more
sourcefn 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. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more