Struct Sort 

pub struct Sort { /* private fields */ }

A single sort key. Produced by .asc() / .desc() on a sortable handle, by Sort::score / Sort::script, or by Geo::distance_sort; chain the option setters (missing_first, mode, unmapped_type, …) onto it.

Implementations

impl Sort

pub fn score() -> Self

Sort by relevance _score (descending by default).

pub fn script( script_type: ScriptSortType, source: impl Into<String>, order: SortOrder, ) -> Self

Sort by a computed script value. script_type is the emitted value type (ScriptSortType::Number / ScriptSortType::String); source is the painless expression.

pub fn asc(self) -> Self

Sort ascending.

pub fn desc(self) -> Self

Sort descending.

pub fn missing_first(self) -> Self

Place documents missing this field first. On a map-key sort this resolves to a direction-correct sentinel in params.missing (a _script sort ignores the missing body field).

pub fn missing_last(self) -> Self

Place documents missing this field last. On a map-key sort this resolves to a direction-correct sentinel in params.missing.

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

Substitute a literal value for documents missing this field. On a map-key sort this becomes the params.missing fallback value.

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

How a multi-valued field reduces to one sort value.

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

Type to assume when the field is unmapped on some shard (instead of failing the search), e.g. "long". A no-op on a map-key _script sort — it’s a field-sort option with no meaning there.

pub fn numeric_type(self, numeric_type: NumericType) -> Self

Numeric type to sort as (NumericType), for cross-index type coercion. A no-op on a map-key _script sort — a field-sort-only option.

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

Date format for a date field sort. A no-op on a map-key _script sort — a field-sort-only option.

pub fn nested_filtered<S>( self, path: impl Into<String>, filter: impl AsQuery<S>, ) -> Self

Sort by a field inside a nested array scoped to path, considering only elements matching filter. An escape hatch for the rare filter-scoped nested sort; ordinary nested sorts come from a Sortable handle, which derives the (possibly multi-level) nested chain from the field’s scope automatically.

Trait Implementations

impl Clone for Sort

fn clone(&self) -> Sort

Returns a duplicate 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<S: FlussoDocument> From<MapKeySort<S>> for Sort

fn from(map_sort: MapKeySort<S>) -> Self

Converts to this type from the input type.