Trait DocSet 

pub trait DocSet: Send + Sync {
    // Required methods
    fn doc(&self) -> DocId;
    fn advance(&mut self) -> DocId;
    fn size_hint(&self) -> u32;

    // Provided method
    fn seek(&mut self, target: DocId) -> DocId { ... }
}

Forward-only cursor over sorted document IDs.

This is the base iteration abstraction. Posting lists, filter cursors, and scorers all implement this trait.

Required Methods

fn doc(&self) -> DocId

Current document ID, or TERMINATED if exhausted.

fn advance(&mut self) -> DocId

Advance to the next document. Returns the new doc ID or TERMINATED.

fn size_hint(&self) -> u32

Estimated number of remaining documents.

Provided Methods

fn seek(&mut self, target: DocId) -> DocId

Seek to the first document >= target. Returns doc ID or TERMINATED.

Trait Implementations

impl DocSet for Box<dyn DocSet + '_>

fn doc(&self) -> DocId

Current document ID, or TERMINATED if exhausted.

fn advance(&mut self) -> DocId

Advance to the next document. Returns the new doc ID or TERMINATED.

fn seek(&mut self, target: DocId) -> DocId

Seek to the first document >= target. Returns doc ID or TERMINATED.

fn size_hint(&self) -> u32

Estimated number of remaining documents.

Implementations on Foreign Types

impl DocSet for Box<dyn DocSet + '_>

fn doc(&self) -> DocId

fn advance(&mut self) -> DocId

fn seek(&mut self, target: DocId) -> DocId

fn size_hint(&self) -> u32

Implementors

impl DocSet for EmptyScorer

impl DocSet for AllDocSet

impl DocSet for EmptyDocSet

impl DocSet for PredicatedScorer<'_>

impl DocSet for SortedVecDocSet

impl<A: DocSet, B: DocSet> DocSet for IntersectionDocSet<A, B>