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::search::doc_id_set_iterator::DocIdSetIterator;
use crate::core::util::error::lucene_error::{LuceneError, Result};

pub trait DocValuesIterator: DocIdSetIterator {
  /// Advances the iterator to exactly `target` and returns whether `target`
  /// has a value.
  ///
  /// # Parameters
  /// - `target`: The target document ID to advance to. `Target` must be
  ///   greater than or equal to the current document ID
  ///   ([`doc_id()`](DocIdSetIterator::doc_id)) and must be a valid document
  ///   ID (i.e., `target >= 0` and `target < max_doc`).
  ///
  /// # Returns
  /// `true` if `target` has a value, otherwise returns `false`.
  ///
  /// # Note
  /// After this method returns, [`doc_id()`](DocIdSetIterator::doc_id)
  /// will return the value of `target`.
  fn advance_exact(&mut self, _target: i32) -> Result<bool> {
    Err(LuceneError::not_implemented(""))
  }
}
impl<S> DocValuesIterator for &mut S
where
  S: DocValuesIterator,
{
  #[inline]
  fn advance_exact(&mut self, target: i32) -> Result<bool> {
    (**self).advance_exact(target)
  }
}