Struct Query

pub struct Query {
    pub _type: String,
    pub include: Option<Vec<String>>,
    pub fields: Option<HashMap<String, Vec<String>>>,
    pub page: Option<PageParams>,
    pub sort: Option<Vec<String>>,
    pub filter: Option<HashMap<String, Vec<String>>>,
}

JSON-API Query parameters

Fields

_type: String

include: Option<Vec<String>>

fields: Option<HashMap<String, Vec<String>>>

page: Option<PageParams>

sort: Option<Vec<String>>

filter: Option<HashMap<String, Vec<String>>>

Implementations

impl Query

JSON-API Query parameters

pub fn from_params(params: &str) -> Self

Takes a query parameter string and returns a Query

use jsonapi_rs::query::Query;
let query = Query::from_params("include=author&fields[articles]=title,\
                                body&fields[people]=name&page[number]=3&page[size]=1");
match query.include {
    None => assert!(false),
    Some(include) => {
        assert_eq!(include.len(), 1);
        assert_eq!(include[0], "author");
    }
}

pub fn to_params(&self) -> String

Builds a query parameter string from a Query

use jsonapi_rs::query::{Query, PageParams};
let query = Query {
  _type: "post".into(),
  include: Some(vec!["author".into()]),
  fields: None,
  page: Some(PageParams {
    size: 5,
    number: 10,
  }),
  sort: None,
  filter: None,
};

let query_string = query.to_params();
assert_eq!(query_string, "include=author&page[size]=5&page[number]=10");

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Query

Returns the “default value” for a type.

impl PartialEq for Query

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