Struct tantivy::SearcherGeneration

source · [−]

pub struct SearcherGeneration { /* private fields */ }

Expand description

Identifies the searcher generation accessed by a Searcher.

While this might seem redundant, a SearcherGeneration contains both a generation_id AND a list of (SegmentId, DeleteOpstamp).

This is on purpose. This object is used by the Warmer API. Having both information makes it possible to identify which artifact should be refreshed or garbage collected.

Depending on the use case, Warmer’s implementers can decide to produce artifacts per:

generation_id (e.g. some searcher level aggregates)
(segment_id, delete_opstamp) (e.g. segment level aggregates)
segment_id (e.g. for immutable document level information)
(generation_id, segment_id) (e.g. for consistent dynamic column)
…

Implementations

source

impl SearcherGeneration

source

pub fn generation_id(&self) -> u64

Returns the searcher generation id.

source

pub fn segments(&self) -> &BTreeMap<SegmentId, Option<Opstamp>>

Return a (SegmentId -> DeleteOpstamp) mapping.

Trait Implementations

source

impl Clone for SearcherGeneration

source

fn clone(&self) -> SearcherGeneration

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 Debug for SearcherGeneration

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl Hash for SearcherGeneration

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher]. Read more

1.3.0

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,

Feeds a slice of this type into the given [Hasher]. Read more

source

impl Ord for SearcherGeneration

source

fn cmp(&self, other: &SearcherGeneration) -> Ordering

This method returns an [Ordering] between self and other. Read more

1.21.0

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0

const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

impl PartialEq<SearcherGeneration> for SearcherGeneration

source

fn eq(&self, other: &SearcherGeneration) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl PartialOrd<SearcherGeneration> for SearcherGeneration

source

fn partial_cmp(&self, other: &SearcherGeneration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl Eq for SearcherGeneration

source

impl StructuralEq for SearcherGeneration

source

impl StructuralPartialEq for SearcherGeneration

Auto Trait Implementations

impl RefUnwindSafe for SearcherGeneration

impl Send for SearcherGeneration

impl Sync for SearcherGeneration

impl Unpin for SearcherGeneration

impl UnwindSafe for SearcherGeneration

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> CallHasher for Twhere
T: Hash + ?Sized,

source

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

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

Implementations

impl SearcherGeneration

pub fn generation_id(&self) -> u64

pub fn segments(&self) -> &BTreeMap<SegmentId, Option<Opstamp>>

Trait Implementations

impl Clone for SearcherGeneration

fn clone(&self) -> SearcherGeneration

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

impl Debug for SearcherGeneration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Hash for SearcherGeneration

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher,

impl Ord for SearcherGeneration

fn cmp(&self, other: &SearcherGeneration) -> Ordering

const fn max(self, other: Self) -> Self

const fn min(self, other: Self) -> Self

const fn clamp(self, min: Self, max: Self) -> Selfwhere Self: PartialOrd<Self>,

impl PartialEq<SearcherGeneration> for SearcherGeneration

fn eq(&self, other: &SearcherGeneration) -> bool

const fn ne(&self, other: &Rhs) -> bool

impl PartialOrd<SearcherGeneration> for SearcherGeneration

fn partial_cmp(&self, other: &SearcherGeneration) -> Option<Ordering>

const fn lt(&self, other: &Rhs) -> bool

const fn le(&self, other: &Rhs) -> bool

const fn gt(&self, other: &Rhs) -> bool

const fn ge(&self, other: &Rhs) -> bool

impl Eq for SearcherGeneration

impl StructuralEq for SearcherGeneration

impl StructuralPartialEq for SearcherGeneration

Auto Trait Implementations

impl RefUnwindSafe for SearcherGeneration

impl Send for SearcherGeneration

impl Sync for SearcherGeneration

impl Unpin for SearcherGeneration

impl UnwindSafe for SearcherGeneration

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> CallHasher for Twhere T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where H: Hash + ?Sized, B: BuildHasher,

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,

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,

const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,

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> CallHasher for Twhere
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

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,