Struct tantivy::IndexReaderBuilder

source · [−]

pub struct IndexReaderBuilder { /* private fields */ }

Expand description

IndexReader builder

It makes it possible to configure:

ReloadPolicy defining when new index versions are detected
Warmer implementations
number of warming threads, for parallelizing warming work
The cache size of the underlying doc store readers.

Implementations

source

impl IndexReaderBuilder

source

pub fn try_into(self) -> Result<IndexReader>

Builds the reader.

Building the reader is a non-trivial operation that requires to open different segment readers. It may take hundreds of milliseconds of time and it may return an error.

source

pub fn reload_policy(self, reload_policy: ReloadPolicy) -> IndexReaderBuilder

Sets the reload_policy.

See ReloadPolicy for more details.

source

pub fn doc_store_cache_size(
self,
doc_store_cache_size: usize
) -> IndexReaderBuilder

Sets the cache size of the doc store readers.

The doc store readers cache by default DOCSTORE_CACHE_CAPACITY(100) decompressed blocks.

source

pub fn warmers(self, warmers: Vec<Weak<dyn Warmer>>) -> IndexReaderBuilder

Set the Warmers that are invoked when reloading searchable segments.

source

pub fn num_warming_threads(
self,
num_warming_threads: usize
) -> IndexReaderBuilder

Sets the number of warming threads.

This allows parallelizing warming work when there are multiple Warmer registered with the IndexReader.

Trait Implementations

source

impl Clone for IndexReaderBuilder

source

fn clone(&self) -> IndexReaderBuilder

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 IndexReaderBuilder

impl Send for IndexReaderBuilder

impl Sync for IndexReaderBuilder

impl Unpin for IndexReaderBuilder

impl !UnwindSafe for IndexReaderBuilder

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::IndexReaderBuilder

Implementations

impl IndexReaderBuilder

pub fn try_into(self) -> Result<IndexReader>

pub fn reload_policy(self, reload_policy: ReloadPolicy) -> IndexReaderBuilder

pub fn doc_store_cache_size( self, doc_store_cache_size: usize) -> IndexReaderBuilder

pub fn warmers(self, warmers: Vec<Weak<dyn Warmer>>) -> IndexReaderBuilder

pub fn num_warming_threads( self, num_warming_threads: usize) -> IndexReaderBuilder

Trait Implementations

impl Clone for IndexReaderBuilder

fn clone(&self) -> IndexReaderBuilder

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 IndexReaderBuilder

impl Send for IndexReaderBuilder

impl Sync for IndexReaderBuilder

impl Unpin for IndexReaderBuilder

impl !UnwindSafe for IndexReaderBuilder

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,

pub fn doc_store_cache_size(
self,
doc_store_cache_size: usize
) -> IndexReaderBuilder

pub fn num_warming_threads(
self,
num_warming_threads: usize
) -> IndexReaderBuilder

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,