Struct rucene::core::codec::postings::blocktree::SegmentTermIteratorInner

pub struct SegmentTermIteratorInner {
    pub input: Option<Box<dyn IndexInput>>,
    pub stack: Vec<SegmentTermsIterFrame>,
    pub current_frame_ord: usize,
    pub term_exists: bool,
    pub term: Vec<u8>,
    pub term_len: usize,
    // some fields omitted
}

Fields

input: Option<Box<dyn IndexInput>>

stack: Vec<SegmentTermsIterFrame>

current_frame_ord: usize

term_exists: bool

term: Vec<u8>

term_len: usize

Methods

impl SegmentTermIteratorInner

pub fn field_reader(&self) -> &FieldReader

pub fn term(&self) -> &[u8]

pub fn init_index_input(&mut self) -> Result<()>

pub fn push_frame_by_fp(
    &mut self,
    arc: Option<FSTArc<ByteSequenceOutput>>,
    fp: i64,
    length: usize
) -> Result<usize>

pub fn current_frame(&self) -> &SegmentTermsIterFrame

pub fn resize_term(&mut self, len: usize)

Trait Implementations

impl TermIterator for SegmentTermIteratorInner

type Postings = Lucene50PostingIterator

type TermState = BlockTermState

fn next(&mut self) -> Result<Option<Vec<u8>>>

Increments the iteration to the next {@link BytesRef} in the iterator. Returns the resulting {@link BytesRef} or null if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.

fn seek_exact(&mut self, target: &[u8]) -> Result<bool>

Attempts to seek to the exact term, returning true if the term is found. If this returns false, the enum is unpositioned. For some codecs, seekExact may be substantially faster than {@link #seekCeil}. */

fn seek_ceil(&mut self, target: &[u8]) -> Result<SeekStatus>

Seeks to the specified term, if it exists, or to the next (ceiling) term. Returns SeekStatus to indicate whether exact term was found, a different term was found, or EOF was hit. The target term may be before or after the current term. If this returns SeekStatus.END, the enum is unpositioned.

fn seek_exact_ord(&mut self, _ord: i64) -> Result<()>

Seeks to the specified term by ordinal (position) as previously returned by {@link #ord}. The target ord may be before or after the current ord, and must be within bounds.

fn seek_exact_state(
    &mut self,
    text: &[u8],
    state: &Self::TermState
) -> Result<()>

fn term(&self) -> Result<&[u8]>

Returns current term. Do not call this when the enum is unpositioned.

fn ord(&self) -> Result<i64>

Returns ordinal position for current term. This is an optional method (the codec may throw {@link UnsupportedOperationException}). Do not call this when the enum is unpositioned.

fn doc_freq(&mut self) -> Result<i32>

Returns the number of documents containing the current term. Do not call this when the enum is unpositioned. {@link SeekStatus#END}.

fn total_term_freq(&mut self) -> Result<i64>

Returns the total number of occurrences of this term across all documents (the sum of the freq() for each doc that has this term). This will be -1 if the codec doesn't support this measure. Note that, like other term measures, this measure does not take deleted documents into account.

fn postings(&mut self) -> Result<Self::Postings>

Get {@link PostingsEnum} for the current term. Do not call this when the enum is unpositioned. This method will not return null. NOTE: the returned iterator may return deleted documents, so deleted documents have to be checked on top of the {@link PostingsEnum}. Use this method if you only require documents and frequencies, and do not need any proximity data. This method is equivalent to {@link #postings(PostingsEnum, int) postings(reuse, PostingsEnum.FREQS)}

fn postings_with_flags(&mut self, flags: u16) -> Result<Self::Postings>

fn term_state(&mut self) -> Result<Self::TermState>

Expert: Returns the TermsEnums internal state to position the TermsEnum without re-seeking the term dictionary. NOTE: A seek by {@link TermState} might not capture the {@link AttributeSource}'s state. Callers must maintain the {@link AttributeSource} states separately

fn is_empty(&self) -> bool