Trait tique::conditional_collector::CheckCondition

pub trait CheckCondition<T>: 'static + Clone {
    fn check(
        &self, 
        segment_ord: SegmentOrdinal, 
        doc_id: DocId, 
        score: T, 
        ascending: bool
    ) -> bool;
}

The condition that gets checked before collection. In order for a document to appear in the results it must first return true for check.

Required methods

fn check(
    &self,
    segment_ord: SegmentOrdinal,
    doc_id: DocId,
    score: T,
    ascending: bool
) -> bool

Decides wether the given document is a valid candidate or not

The ascending parameter signals the ordering chosen via Ascending or Descending

Implementations on Foreign Types

impl<T> CheckCondition<T> for bool

fn check(&self, _: SegmentOrdinal, _: DocId, _: T, _: bool) -> bool

impl<T> CheckCondition<T> for (T, DocAddress) where
    T: 'static + PartialOrd + Copy, 

fn check(
    &self,
    segment_ord: SegmentOrdinal,
    doc_id: DocId,
    score: T,
    ascending: bool
) -> bool

Implementors

impl<F, T> CheckCondition<T> for F where
    F: 'static + Clone + Fn(SegmentOrdinal, DocId, T, bool) -> bool,