Enum tantivy::query::EnableScoring

pub enum EnableScoring<'a> {
    Enabled {
        searcher: &'a Searcher,
        statistics_provider: &'a dyn Bm25StatisticsProvider,
    },
    Disabled {
        schema: &'a Schema,
        searcher_opt: Option<&'a Searcher>,
    },
}

Argument used in Query::weight(..)

Variants

Enabled

Pass this to enable scoring.

Fields

searcher: &'a Searcher

The searcher to use during scoring.

statistics_provider: &'a dyn Bm25StatisticsProvider

A Bm25StatisticsProvider used to compute BM25 scores.

Normally this should be the Searcher, but you can specify a custom one to adjust the statistics.

Disabled

Pass this to disable scoring. This can improve performance.

Fields

schema: &'a Schema

Schema is required.

searcher_opt: Option<&'a Searcher>

Searcher should be provided if available.

Implementations

impl<'a> EnableScoring<'a>

pub fn enabled_from_searcher(searcher: &'a Searcher) -> EnableScoring<'a>

Create using Searcher with scoring enabled.

pub fn enabled_from_statistics_provider( statistics_provider: &'a dyn Bm25StatisticsProvider, searcher: &'a Searcher ) -> EnableScoring<'a>

Create using a custom Bm25StatisticsProvider with scoring enabled.

pub fn disabled_from_searcher(searcher: &'a Searcher) -> EnableScoring<'a>

Create using Searcher with scoring disabled.

pub fn disabled_from_schema(schema: &'a Schema) -> EnableScoring<'a>

Create using Schema with scoring disabled.

pub fn searcher(&self) -> Option<&Searcher>

Returns the searcher if available.

pub fn schema(&self) -> &Schema

Returns the schema.

pub fn is_scoring_enabled(&self) -> bool

Returns true if the scoring is enabled.

Trait Implementations

impl<'a> Clone for EnableScoring<'a>

fn clone(&self) -> EnableScoring<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for EnableScoring<'a>