Struct QuerySearch 

pub struct QuerySearch {
    pub q: Option<String>,
    pub sort: Option<String>,
    pub offset: i64,
    pub page_size: i64,
    pub include_total: Option<bool>,
}

Struct used to deserialize with serde query strings from a request URL.

Examples

Valid URLs could be:

• /api/users?q=marian&include_total=true
• /api/v1/sales?q=customer:john&page_size=100
• /some-endpoint?page_size=20&sort=-name

When an instance is created through serde, the page_size attribute is set to 50 if the stream serialized does not have the value set.

Fields

q: Option<String>

sort: Option<String>

offset: i64

page_size: i64

include_total: Option<bool>

Implementations

impl QuerySearch

pub fn parse_sort(&self, allowed_fields: &[&str]) -> Vec<String>

Parse sort argument “col1,col2,-col3…” into a vector of strings, and if the column name starts with “-”, it’s translated to a DESC keyword, e.g. “-name” –> “name DESC”.

use actix_contrib_rest::query::QuerySearch;
let q = QuerySearch { q: None, offset: 0, page_size: 10, sort: None, include_total: None };
assert_eq!(q.parse_sort(&["a", "b"]), Vec::<String>::new());
let q = QuerySearch { q: None, offset: 0, page_size: 10, sort: Some(String::from("a,-b")), include_total: None };
assert_eq!(q.parse_sort(&["a", "b"]), &[String::from("a"), String::from("b DESC")]);
let q = QuerySearch { q: None, offset: 0, page_size: 10, sort: Some(String::from("name,-b,c")), include_total: None };
assert_eq!(q.parse_sort(&vec!["name", "c"]), &[String::from("name"), String::from("c")]);

pub fn sort_as_order_by_args( &self, allowed_fields: &[&str], default: &str, ) -> String

Parse sort argument “col1,col2,-col3…” into a compatible SQL ORDER BY expression, e.g. name,-age –> name, age DESC, to be concatenated in a SQL SELECT query.

use actix_contrib_rest::query::QuerySearch;
let q = QuerySearch { q: None, offset: 0, page_size: 10, sort: None, include_total: None };
assert_eq!(q.sort_as_order_by_args(&["a", "b"], "a"), "a");
let q = QuerySearch { q: None, offset: 0, page_size: 10, sort: Some(String::from("a,-b")), include_total: None };
assert_eq!(q.sort_as_order_by_args(&["a", "b"], "a"), "a, b DESC");
let q = QuerySearch { q: None, offset: 0, page_size: 10, sort: Some(String::from("name,-b,c")), include_total: None };
assert_eq!(q.sort_as_order_by_args(&["a", "h"], "c"), "c");

Trait Implementations

impl Clone for QuerySearch

fn clone(&self) -> QuerySearch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuerySearch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QuerySearch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for QuerySearch

impl PartialEq for QuerySearch

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

impl Validate for QuerySearch

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for QuerySearch

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>