Struct json_api::query::Sort

pub struct Sort {
    pub direction: Direction,
    pub field: Path,
    // some fields omitted
}

A single sort instruction containing a direction and field path.

Fields

direction: Direction

The direction to sort by.

field: Path

The name of the field to sort by.

Methods

impl Sort

fn new(field: Path, direction: Direction) -> Self

Returns a new Sort.

fn reverse(&self) -> Self

Returns a cloned inverse of self.

Example

use json_api::query::{Direction, Sort};

let chrono = Sort::new("created-at".parse()?, Direction::Asc);
let latest = chrono.reverse();

assert_eq!(chrono.field, latest.field);
assert_eq!(chrono.direction, Direction::Asc);
assert_eq!(latest.direction, Direction::Desc);

Trait Implementations

impl Clone for Sort

fn clone(&self) -> Sort

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sort

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Sort

impl Hash for Sort

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq for Sort

fn eq(&self, __arg_0: &Sort) -> bool

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

fn ne(&self, __arg_0: &Sort) -> bool

This method tests for !=.

impl Display for Sort

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

Formats the value using the given formatter.

impl FromStr for Sort

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Neg for Sort

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'de> Deserialize<'de> for Sort

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Sort

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Stringify for Sort

fn to_bytes(&self) -> Vec<u8>

Returns the string representation of the give value as a byte vector.

fn stringify(&self) -> String

Returns the string representation of the given value.