Struct elasticsearch_dsl::search::sort::GeoDistanceSort

pub struct GeoDistanceSort { /* 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 GeoDistanceSort

pub fn new<T, U>(field: T, points: U) -> Self where
    T: ToString,
    U: IntoIterator,
    U::Item: Into<GeoLocation>, 

Creates an instance of GeoDistanceSort

pub fn ascending<T, U>(field: T, points: U) -> Self where
    T: ToString,
    U: IntoIterator,
    U::Item: Into<GeoLocation>, 

Creates an instance of GeoDistanceSort by ascending order

pub fn descending<T, U>(field: T, points: U) -> Self where
    T: ToString,
    U: IntoIterator,
    U::Item: Into<GeoLocation>, 

Creates an instance of GeoDistanceSort 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 unit(self, unit: DistanceUnit) -> Self

The unit to use when computing sort values

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

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 distance_type(self, distance_type: GeoDistanceType) -> Self

How to compute the distance. Can either be arc (default), or plane (faster, but inaccurate on long distances and close to the poles).

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

pub fn ignore_unmapped(self, ignore_unmapped: bool) -> Self

Indicates if the unmapped field should be treated as a missing value. Setting it to true is equivalent to specifying an unmapped_type in the field sort. The default is false (unmapped field cause the search to fail).

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

Trait Implementations

impl Clone for GeoDistanceSort

fn clone(&self) -> GeoDistanceSort

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeoDistanceSort

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

Formats the value using the given formatter.

impl From<GeoDistanceSort> for Sort

fn from(value: GeoDistanceSort) -> Self

Converts to this type from the input type.

impl IntoIterator for GeoDistanceSort

type Item = GeoDistanceSort

The type of the elements being iterated over.

type IntoIter = IntoIter<<GeoDistanceSort 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<GeoDistanceSort> for GeoDistanceSort

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

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

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

This method tests for !=.

impl Serialize for GeoDistanceSort

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 GeoDistanceSort