Struct SortOrder

pub struct SortOrder {
    pub order_id: i64,
    pub fields: Vec<SortField>,
}

A sort order is defined by a sort order id and a list of sort fields. The order of the sort fields within the list defines the order in which the sort is applied to the data.

Fields

order_id: i64

Identifier for SortOrder, order_id 0 is no sort order.

fields: Vec<SortField>

Details of the sort

Implementations

impl SortOrder

pub fn builder() -> SortOrderBuilder

Create sort order builder

pub fn unsorted_order() -> SortOrder

Create an unbound unsorted order

pub fn is_unsorted(&self) -> bool

Returns true if the sort order is unsorted.

A SortOrder is unsorted if it has no sort fields.

pub fn with_order_id(self, order_id: i64) -> SortOrder

Set the order id for the sort order

Trait Implementations

impl Clone for SortOrder

fn clone(&self) -> SortOrder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SortOrder

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

Formats the value using the given formatter.

impl Default for SortOrder

fn default() -> SortOrder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SortOrder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SortOrder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SortOrder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SortOrder

impl StructuralPartialEq for SortOrder