Struct elasticsearch_dsl::search::sort::Sort

pub struct Sort {
    pub field: SortField,
    pub order: Option<SortOrder>,
    pub mode: Option<SortMode>,
    pub unmapped_type: Option<String>,
    pub missing: Option<SortMissing>,
}

Sorts search hits by other field values

https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html#sort-search-results

Fields

field: SortField

Field to sort by

order: Option<SortOrder>

Explicit order

https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html#_sort_order

mode: Option<SortMode>

Sort mode for numeric fields

https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html#_sort_mode_option

unmapped_type: Option<String>

Fallback type if mapping is not defined

https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html#_ignoring_unmapped_fields

missing: Option<SortMissing>

The missing parameter specifies how docs which are missing the sort field should be treated

https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html#_missing_values

Implementations

impl Sort

pub fn new(field: impl Into<SortField>) -> Self

Creates a new sort instance

pub fn order(self, order: SortOrder) -> Self

Sets sort order

pub fn mode(self, mode: SortMode) -> Self

Sets sort mode

pub fn unmapped_type(self, unmapped_type: impl Into<String>) -> Self

Sets unmapped type

pub fn missing(self, missing: impl Into<SortMissing>) -> Self

Sets missing value

Trait Implementations

impl Clone for Sort

fn clone(&self) -> Sort

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sort

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

Formats the value using the given formatter.

impl From<Sort> for Vec<Sort>

fn from(sort: Sort) -> Self

Performs the conversion.

impl PartialEq<Sort> for Sort

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

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

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

This method tests for !=.

impl PartialOrd<Sort> for Sort

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Sort

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sort