Struct Sort

pub struct Sort {
    pub direction: Direction,
    pub field: Path,
    /* private fields */
}

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.

Implementations

impl Sort

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

Returns a new Sort.

pub 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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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 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 Hash for Sort

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Neg for Sort

type Output = Sort

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Sort

fn eq(&self, other: &Sort) -> 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 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.

impl Eq for Sort

impl StructuralPartialEq for Sort