Struct SortParams 

pub struct SortParams {
    pub sort_by: String,
    pub direction: SortDirection,
}

Query parameters for sorting a collection endpoint.

{"sort_by": "created_at", "direction": "desc"}

Fields

sort_by: String

The field name to sort by (e.g. "created_at", "name").

direction: SortDirection

Sort direction. Defaults to SortDirection::Asc.

Implementations

impl SortParams

pub fn new(sort_by: impl Into<String>, direction: SortDirection) -> SortParams

Create sort params with the given field and direction.

Examples

use api_bones::query::{SortParams, SortDirection};

let p = SortParams::new("created_at", SortDirection::Desc);
assert_eq!(p.sort_by, "created_at");
assert_eq!(p.direction, SortDirection::Desc);

pub fn asc(sort_by: impl Into<String>) -> SortParams

Create sort params with ascending direction.

Examples

use api_bones::query::{SortParams, SortDirection};

let p = SortParams::asc("name");
assert_eq!(p.direction, SortDirection::Asc);

pub fn desc(sort_by: impl Into<String>) -> SortParams

Create sort params with descending direction.

Examples

use api_bones::query::{SortParams, SortDirection};

let p = SortParams::desc("created_at");
assert_eq!(p.direction, SortDirection::Desc);

Trait Implementations

impl Clone for SortParams

fn clone(&self) -> SortParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SortParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SortParams

fn deserialize<__D>( __deserializer: __D, ) -> Result<SortParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> FromRequestParts<S> for SortParams

where S: Send + Sync,

type Rejection = ApiError

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<SortParams, <SortParams as FromRequestParts<S>>::Rejection>

Perform the extraction.

impl PartialEq for SortParams

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SortParams

impl StructuralPartialEq for SortParams