Enum elasticsearch_dsl::search::queries::params::Function

pub enum Function {
    Weight(Weight),
    RandomScore(RandomScore),
    FieldValueFactor(FieldValueFactor),
    DecayDateTime(Decay<DateTime<Utc>>),
    DecayLocation(Decay<GeoPoint>),
    DecayI8(Decay<i8>),
    DecayI16(Decay<i16>),
    DecayI32(Decay<i32>),
    DecayI64(Decay<i64>),
    DecayU8(Decay<u8>),
    DecayU16(Decay<u16>),
    DecayU32(Decay<u32>),
    DecayU64(Decay<u64>),
    Script(Script),
}

Functions available for use in FunctionScoreQuery

Variants

Weight(Weight)

Tuple Fields

0: Weight

RandomScore(RandomScore)

Tuple Fields

0: RandomScore

FieldValueFactor(FieldValueFactor)

Tuple Fields

0: FieldValueFactor

DecayDateTime(Decay<DateTime<Utc>>)

Tuple Fields

0: Decay<DateTime<Utc>>

DecayLocation(Decay<GeoPoint>)

Tuple Fields

0: Decay<GeoPoint>

DecayI8(Decay<i8>)

Tuple Fields

0: Decay<i8>

DecayI16(Decay<i16>)

Tuple Fields

0: Decay<i16>

DecayI32(Decay<i32>)

Tuple Fields

0: Decay<i32>

DecayI64(Decay<i64>)

Tuple Fields

0: Decay<i64>

DecayU8(Decay<u8>)

Tuple Fields

0: Decay<u8>

DecayU16(Decay<u16>)

Tuple Fields

0: Decay<u16>

DecayU32(Decay<u32>)

Tuple Fields

0: Decay<u32>

DecayU64(Decay<u64>)

Tuple Fields

0: Decay<u64>

Script(Script)

Tuple Fields

0: Script

Implementations

impl Function

pub fn weight(weight: f32) -> Weight

Creates an instance of Weight

pub fn random_score() -> RandomScore

Creates an instance of RandomScore

pub fn field_value_factor(field: impl Into<String>) -> FieldValueFactor

Creates an instance of FieldValueFactor

• field - Field to be extracted from the document.

pub fn decay<T: Origin>(
    function: DecayFunction,
    field: impl Into<String>,
    origin: T,
    scale: <T as Origin>::Scale
) -> Decay<T>

Creates an instance of Decay

• function - Decay function variant
• field - Field to apply function to
• origin - The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. Required for geo and numeric field. For date fields the default is now. Date math (for example now-1h) is supported for origin.
• scale - Required for all types. Defines the distance from origin + offset at which the computed score will equal decay parameter. For geo fields: Can be defined as number+unit (1km, 12m,…​). Default unit is meters. For date fields: Can to be defined as a number+unit (“1h”, “10d”,…​). Default unit is milliseconds. For numeric field: Any number.

pub fn script(source: impl Into<String>) -> Script

Creates an instance of Script

• source - script source

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl From<Decay<DateTime<Utc>>> for Function

fn from(q: Decay<DateTime<Utc>>) -> Self

Performs the conversion.

impl From<Decay<GeoPoint>> for Function

fn from(q: Decay<GeoPoint>) -> Self

Performs the conversion.

impl From<Decay<i16>> for Function

fn from(q: Decay<i16>) -> Self

Performs the conversion.

impl From<Decay<i32>> for Function

fn from(q: Decay<i32>) -> Self

Performs the conversion.

impl From<Decay<i64>> for Function

fn from(q: Decay<i64>) -> Self

Performs the conversion.

impl From<Decay<i8>> for Function

fn from(q: Decay<i8>) -> Self

Performs the conversion.

impl From<Decay<u16>> for Function

fn from(q: Decay<u16>) -> Self

Performs the conversion.

impl From<Decay<u32>> for Function

fn from(q: Decay<u32>) -> Self

Performs the conversion.

impl From<Decay<u64>> for Function

fn from(q: Decay<u64>) -> Self

Performs the conversion.

impl From<Decay<u8>> for Function

fn from(q: Decay<u8>) -> Self

Performs the conversion.

impl From<FieldValueFactor> for Function

fn from(q: FieldValueFactor) -> Self

Performs the conversion.

impl From<RandomScore> for Function

fn from(q: RandomScore) -> Self

Performs the conversion.

impl From<Script> for Function

fn from(q: Script) -> Self

Performs the conversion.

impl From<Weight> for Function

fn from(q: Weight) -> Self

Performs the conversion.

impl PartialEq<Function> for Function

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Function

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Function