Struct stac_api::Sortby

pub struct Sortby {
    pub field: String,
    pub direction: Direction,
}

Fields by which to sort results.

Fields

field: String

The field to sort by.

direction: Direction

The direction to sort by.

Implementations

impl Sortby

pub fn asc(field: impl ToString) -> Sortby

Creates a new ascending sortby for the field.

Examples

let sortby = Sortby::asc("id");

pub fn desc(field: impl ToString) -> Sortby

Creates a new descending sortby for the field.

Examples

let sortby = Sortby::desc("id");

pub fn from_query_param(s: &str) -> Vec<Sortby>

Creates a vector of Sortbys from a comma-delimited list.

Examples

let sortbys = Sortby::from_query_param("+id,-datetime");

Trait Implementations

impl Debug for Sortby

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sortby

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

Deserialize this value from the given Serde deserializer.

impl FromStr for Sortby

type Err = Infallible

The associated error which can be returned from parsing.

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

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

impl PartialEq<Sortby> for Sortby

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

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

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 Sortby

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 Sortby