Struct OrderBy 

pub struct OrderBy { /* private fields */ }

A field sort minus the field — a direction plus the field-sort modifiers, ready to attach to whatever handle SortBuilder::by is given.

This is what a consumer converts its own request enum into, once (impl From<MyDir> for OrderBy). It carries full parity with Sort’s field-sort options; everything but the direction defaults to unset.

Implementations

impl OrderBy

pub fn asc() -> Self

Ascending, no modifiers.

pub fn desc() -> Self

Descending, no modifiers.

pub fn missing_first(self) -> Self

Place documents missing this field first.

pub fn missing_last(self) -> Self

Place documents missing this field last.

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

Substitute a literal value for documents missing this field.

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

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

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

Numeric type to sort as, for cross-index type coercion.

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

Type to assume when the field is unmapped on some shard.

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

Date format for a date field sort.

Trait Implementations

impl Clone for OrderBy

fn clone(&self) -> OrderBy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderBy

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

Formats the value using the given formatter.

impl From<OrderBy> for MaybeOrderBy

fn from(order: OrderBy) -> Self

Converts to this type from the input type.

impl From<SortOrder> for OrderBy

fn from(order: SortOrder) -> Self

Converts to this type from the input type.