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::codecs::DefaultPointsFormat;
use crate::core::codecs::points_format::PointsFormat;
use crate::core::index::point_values::PointValues;
use crate::core::util::close::CloseableRef;
use crate::core::util::error::lucene_error::Result;
use std::sync::Arc;
/// Abstract API to visit point values.
pub trait PointsReader: CloseableRef {
  /// Checks consistency of this reader.
  ///
  /// Note that this may be costly in terms of I/O, e.g. may involve computing
  /// a checksum value against large data files.
  fn check_integrity(&self) -> Result<()>;

  type PointValuesType: PointValues;
  fn get_values(&self, field: &str) -> Result<Option<Self::PointValuesType>>;

  /// Whether this is a Lucene90 points reader whose leaves are sorted in the
  /// order required by `BKDWriter::merge`.
  fn is_lucene90_points_reader(&self) -> bool {
    false
  }

  /// Returns an instance optimized for merging. This instance may only be
  /// cloned
  /// # Note
  /// Returning None means returning itself.
  fn get_merge_instance(&self) -> Result<Option<Self>>
  where
    Self: Sized,
  {
    Ok(None)
  }
}
pub type DefaultPointsReader<I> = <DefaultPointsFormat as PointsFormat>::PointsReader<I>;

impl<T> PointsReader for Arc<T>
where
  T: PointsReader,
{
  fn check_integrity(&self) -> Result<()> {
    (**self).check_integrity()
  }

  type PointValuesType = T::PointValuesType;

  fn get_values(&self, field: &str) -> Result<Option<Self::PointValuesType>> {
    (**self).get_values(field)
  }

  fn is_lucene90_points_reader(&self) -> bool {
    (**self).is_lucene90_points_reader()
  }

  fn get_merge_instance(&self) -> Result<Option<Self>>
  where
    Self: Sized,
  {
    let v = match (**self).get_merge_instance()? {
      Some(v) => Arc::new(v),
      None => return Ok(None),
    };
    Ok(Some(v))
  }
}