Enum FunctionBoostMode

pub enum FunctionBoostMode {
    Multiply,
    Replace,
    Sum,
    Avg,
    Max,
    Min,
}

The newly computed score is combined with the score of the query. The parameter boost_mode defines how.

Variants

Multiply

Query score and function score is multiplied (default)

Replace

Only function score is used, the query score is ignored

Sum

Query score and function score are added

Avg

Average

Max

Max of query score and function score

Min

Min of query score and function score

Trait Implementations

impl Clone for FunctionBoostMode

fn clone(&self) -> FunctionBoostMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionBoostMode

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

Formats the value using the given formatter.

impl Default for FunctionBoostMode

fn default() -> Self

Returns the “default value” for a type.

impl Ord for FunctionBoostMode

fn cmp(&self, other: &FunctionBoostMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FunctionBoostMode

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

fn partial_cmp(&self, other: &FunctionBoostMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FunctionBoostMode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FunctionBoostMode

impl Eq for FunctionBoostMode

impl StructuralPartialEq for FunctionBoostMode