Struct DocumentSuggesterOptions 

#[non_exhaustive]
pub struct DocumentSuggesterOptions {
    pub source_field: String,
    pub fuzzy_matching: Option<SuggesterFuzzyMatching>,
    pub sort_expression: Option<String>,
}

Options for a search suggester.

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.

source_field: String

The name of the index field you want to use for suggestions.

fuzzy_matching: Option<SuggesterFuzzyMatching>

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

sort_expression: Option<String>

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Implementations

impl DocumentSuggesterOptions

pub fn source_field(&self) -> &str

The name of the index field you want to use for suggestions.

pub fn fuzzy_matching(&self) -> Option<&SuggesterFuzzyMatching>

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

pub fn sort_expression(&self) -> Option<&str>

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

impl DocumentSuggesterOptions

pub fn builder() -> DocumentSuggesterOptionsBuilder

Creates a new builder-style object to manufacture DocumentSuggesterOptions.

Trait Implementations

impl Clone for DocumentSuggesterOptions

fn clone(&self) -> DocumentSuggesterOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSuggesterOptions

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

Formats the value using the given formatter.

impl PartialEq for DocumentSuggesterOptions

fn eq(&self, other: &DocumentSuggesterOptions) -> 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 DocumentSuggesterOptions