restqs 0.1.0

REST Query Syntax parser for safe REST API filtering plans.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Database-neutral RQS query plan.

use crate::{Filter, Pagination, Projection, SortTerm};

/// Parsed RQS query plan.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct RqsQuery {
    filters: Vec<Filter>,
    sort: Vec<SortTerm>,
    projection: Projection,
    pagination: Pagination,
}

impl RqsQuery {
    /// Create an empty query plan.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Return all filters.
    #[must_use]
    pub fn filters(&self) -> &[Filter] {
        &self.filters
    }

    /// Return all sort terms.
    #[must_use]
    pub fn sort(&self) -> &[SortTerm] {
        &self.sort
    }

    /// Return the projection.
    #[must_use]
    pub fn projection(&self) -> &Projection {
        &self.projection
    }

    /// Return pagination.
    #[must_use]
    pub fn pagination(&self) -> Pagination {
        self.pagination
    }

    pub(crate) fn push_filter(&mut self, filter: Filter) {
        self.filters.push(filter);
    }

    pub(crate) fn set_sort(&mut self, sort: Vec<SortTerm>) {
        self.sort = sort;
    }

    pub(crate) fn set_projection(&mut self, projection: Projection) {
        self.projection = projection;
    }

    pub(crate) fn pagination_mut(&mut self) -> &mut Pagination {
        &mut self.pagination
    }
}