Struct tantivy::SearcherGeneration

pub struct SearcherGeneration { /* private fields */ }

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

impl SearcherGeneration

pub fn generation_id(&self) -> u64

Returns the searcher generation id.

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

Return a (SegmentId -> DeleteOpstamp) mapping.

Trait Implementations

impl Clone for SearcherGeneration

fn clone(&self) -> SearcherGeneration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearcherGeneration

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

Formats the value using the given formatter.

impl Hash for SearcherGeneration

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SearcherGeneration

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SearcherGeneration

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

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

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.

impl PartialOrd for SearcherGeneration

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

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

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

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

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

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

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

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

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

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

impl Eq for SearcherGeneration

impl StructuralPartialEq for SearcherGeneration