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::OnCommit (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

const 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 !RefUnwindSafe for IndexReader

impl Send for IndexReader

impl Sync for IndexReader

impl Unpin for IndexReader

impl !UnwindSafe for IndexReader

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable

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

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for Twhere
T: Any,

source

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

source

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

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. Read more

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. Read more

source

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

source

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

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

impl<T> From<T> for T

const: unstable

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere
U: From<T>,

const: unstable

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

source

impl<T> Pointable for T

source

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

source

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

source

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

source

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

source

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

source

fn vzip(self) -> V

source

Struct tantivy::IndexReader

Implementations

impl IndexReader

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

pub fn searcher(&self) -> Searcher

Trait Implementations

impl Clone for IndexReader

fn clone(&self) -> IndexReader

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

impl TryInto<IndexReader> for IndexReaderBuilder

type Error = TantivyError

fn try_into(self) -> Result<IndexReader>

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> Fruit for Twhere T: Send + Downcast,

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

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

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

impl<T> Downcast for Twhere
T: Any,

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

impl<T> Fruit for Twhere
T: Send + Downcast,