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 std::fmt::Write as _;

use crate::core::search::explanation::Explanation;
use crate::core::search::scorer::Scorer;
use crate::core::util::error::lucene_error::Result;
/// A Weight that has a constant score equal to the boost of the wrapped query.
/// This is typically useful when building queries which do not produce
/// meaningful scores and are mostly useful for filtering.
#[derive(Clone, Default)]
pub struct ConstantScoreWeight {
  score: f32,
}
impl ConstantScoreWeight {
  pub fn new(score: f32) -> Self {
    Self { score }
  }
  /// Return the score produced by this Weight.
  pub fn score(&self) -> f32 {
    self.score
  }
  pub fn explain<S, T>(&self, scorer: Option<S>, doc: i32, query_str: T) -> Result<Explanation>
  where
    S: Scorer,
    T: Into<String>,
  {
    let exists = match scorer {
      None => false,
      Some(mut s) => {
        if s.has_two_phase_iterator() == crate::core::search::scorer::TwoPhaseState::Yes {
          s.approx_advance(doc)? == doc && s.matches()?
        } else {
          s.advance(doc)? == doc
        }
      },
    };

    if exists {
      if self.score == 1.0 {
        let query_str: String = query_str.into();
        Ok(Explanation::match_no_details(self.score, query_str))
      } else {
        let mut query_str = query_str.into();
        write!(query_str, "^{}", self.score)?;
        Ok(Explanation::match_no_details(self.score, query_str))
      }
    } else {
      let mut query_str = query_str.into();
      write!(query_str, " doesn't match id {}", doc)?;
      Ok(Explanation::no_match(query_str, vec![]))
    }
  }
}