rlucene 0.1.0-alpha.3

A Rust port of Apache Lucene, a full-text search engine library
Documentation
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
use crate::core::index::postings_enum::PostingsEnum;
use crate::core::search::matches_iterator::MatchesIterator;
use crate::core::search::query::Query;
use crate::core::util::error::lucene_error::Result;
use std::sync::Arc;

/// A [`MatchesIterator`] over a single term's postings list
pub struct TermMatchesIterator<PE> {
  upto: i32,
  pos: i32,
  pe: PE,
  query: Arc<Query>,
}
impl<PE> TermMatchesIterator<PE>
where
  PE: PostingsEnum,
{
  /// Create a new [`TermMatchesIterator`] for the given term and postings list.
  pub fn new(mut pe: PE, query: Arc<Query>) -> Result<Self> {
    Ok(TermMatchesIterator {
      upto: pe.freq()?,
      pos: 0,
      pe,
      query,
    })
  }
}
impl<PE> MatchesIterator for TermMatchesIterator<PE>
where
  PE: PostingsEnum,
{
  type SubMatches<'a>
    = crate::core::search::dummy::dummy_matches_iterator::DummyMatchesIterator
  where
    Self: 'a;
  fn next(&mut self) -> Result<bool> {
    let prev = self.upto;
    self.upto -= 1;
    if prev > 0 {
      self.pos = self.pe.next_position()?;
      Ok(true)
    } else {
      Ok(false)
    }
  }

  fn start_position(&self) -> Result<i32> {
    Ok(self.pos)
  }

  fn end_position(&self) -> Result<i32> {
    Ok(self.pos)
  }

  fn start_offset(&self) -> Result<i32> {
    self.pe.start_offset()
  }

  fn end_offset(&self) -> Result<i32> {
    self.pe.end_offset()
  }

  fn get_sub_matches(&mut self) -> Result<Option<Self::SubMatches<'_>>> {
    Ok(None)
  }

  fn get_query(&self) -> Result<&Arc<Query>> {
    Ok(&self.query)
  }
}