Struct rabbithole::query::Query

pub struct Query {
    pub include: Option<IncludeQuery>,
    pub fields: FieldsQuery,
    pub sort: SortQuery,
    pub page: Option<PageQuery>,
    pub filter: Option<FilterQuery>,
}

Fields

include: Option<IncludeQuery>

When include is:

1. None: all included fields will be added
2. Some(<empty-query>): no included field will be added
3. Some(<some-query>):
4. No query matches the existing fields: like branch 2
5. Otherwise: all matched fields will be added

fields: FieldsQuery

If ty is marked in fields map:

1. If fields[<ty>] is not empty: all resources of this type will remove the attributes and relationships which are not in fields[<ty>]
2. If fields[<ty>] is empty: all the fields of the resources with this type will be removed Else: retain all fields

sort: SortQuery

When sort is:

1. empty: no sorting at all, clients should not expect the order of the result
2. some values, but none of the values matches: like branch 1
3. some values, and some of the items matches: sorting result with the order of the matched sort-query item

page: Option<PageQuery>

filter: Option<FilterQuery>

Methods

impl Query

pub fn from_uri(uri: &Uri) -> RbhResult<Query>

Trait Implementations

impl Default for Query

fn default() -> Query

Returns the "default value" for a type.

impl Debug for Query

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

Formats the value using the given formatter.