Trait tantivy::DocSet [−] [src]

pub trait DocSet {
    fn advance(&mut self) -> bool;
    fn doc(&self) -> DocId;
    fn size_hint(&self) -> usize;

    fn skip_next(&mut self, target: DocId) -> SkipResult { ... }
    fn next(&mut self) -> Option<DocId> { ... }
}

Represents an iterable set of sorted doc ids.

Required Methods

Goes to the next element. .advance(...) needs to be called a first time to point to the correct element.

Returns the current document

Returns a best-effort hint of the length of the docset.

Provided Methods

After skipping, position the iterator in such a way that .doc() will return a value greater than or equal to target.

SkipResult expresses whether the target value was reached, overstepped, or if the DocSet was entirely consumed without finding any value greater or equal to the target.

WARNING: Calling skip always advances the docset. More specifically, if the docset is already positionned on the target skipping will advance to the next position and return SkipResult::Overstep.

Advances the cursor to the next document None is returned if the iterator has DocSet has already been entirely consumed.

Implementors