Struct elasticsearch_dsl::search::sort::FieldSort

pub struct FieldSort { /* private fields */ }

Sorts search hits by other field values

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

Implementations

impl FieldSort

pub fn new<T>(field: T) -> Self where
    T: ToString, 

Creates an instance of FieldSort

pub fn ascending<T>(field: T) -> Self where
    T: ToString, 

Creates an instance of FieldSort by ascending order

pub fn descending<T>(field: T) -> Self where
    T: ToString, 

Creates an instance of FieldSort by descending order

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

Explicit order

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

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

Sort mode for numeric fields

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

pub fn unmapped_type<T>(self, unmapped_type: T) -> Self where
    T: ToString, 

Fallback type if mapping is not defined

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

pub fn format<T>(self, format: T) -> Self where
    T: ToString, 

Optional format for datetime sorts

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

pub fn missing<T>(self, missing: T) -> Self where
    T: Serialize, 

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

Trait Implementations

impl Clone for FieldSort

fn clone(&self) -> FieldSort

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSort

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

Formats the value using the given formatter.

impl From<FieldSort> for Sort

fn from(value: FieldSort) -> Self

Converts to this type from the input type.

impl IntoIterator for FieldSort

type Item = FieldSort

The type of the elements being iterated over.

type IntoIter = IntoIter<<FieldSort as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<FieldSort> for FieldSort

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

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

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

This method tests for !=.

impl Serialize for FieldSort

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 FieldSort