Struct elasticsearch_dsl::search::sort::SortCollection

pub struct SortCollection(_);

A sorting criteria

Implementations

impl SortCollection

pub fn new() -> Self

Creates a new instance of SortCollection

pub fn extend<T>(&mut self, sort: T)where
    T: IntoIterator,
    T::Item: Into<Sort>,

Extends sorting collection

pub fn ascending<T>(self, field: T) -> Selfwhere
    T: ToString,

Add a field to sort by ascending order

pub fn descending<T>(self, field: T) -> Selfwhere
    T: ToString,

Add a field to sort by descending order

pub fn field(self, field_sort: FieldSort) -> Self

Add a field sort

Trait Implementations

impl Clone for SortCollection

fn clone(&self) -> SortCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SortCollection

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

Formats the value using the given formatter.

impl Default for SortCollection

fn default() -> SortCollection

Returns the “default value” for a type.

impl IntoIterator for SortCollection

type Item = Sort

The type of the elements being iterated over.

type IntoIter = IntoIter<<SortCollection as IntoIterator>::Item, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<SortCollection> for SortCollection

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SortCollection

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 SortCollection