Struct DocumentRelevanceConfiguration 

#[non_exhaustive]
pub struct DocumentRelevanceConfiguration {
    pub name: String,
    pub relevance: Option<Relevance>,
}

Overrides the document relevance properties of a custom index field.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the index field.

relevance: Option<Relevance>

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Implementations

impl DocumentRelevanceConfiguration

pub fn name(&self) -> &str

The name of the index field.

pub fn relevance(&self) -> Option<&Relevance>

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

impl DocumentRelevanceConfiguration

pub fn builder() -> DocumentRelevanceConfigurationBuilder

Creates a new builder-style object to manufacture DocumentRelevanceConfiguration.

Trait Implementations

impl Clone for DocumentRelevanceConfiguration

fn clone(&self) -> DocumentRelevanceConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentRelevanceConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocumentRelevanceConfiguration

fn eq(&self, other: &DocumentRelevanceConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentRelevanceConfiguration