headless_common 0.1.1

Shared types useful for making requests to various Liferay headless APIs
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
61
62
63

use super::{field_collection::FieldCollection, filter::FilterExpression, sort::SortCollection};
use std::fmt::Display;

/// Params common to Page requests
#[derive(Clone, Debug, PartialEq)]

pub struct PageParams<'a, Fields>
where
    Fields: Display,
{
    /// A list of field names to aggregate
    pub agregation_terms: Option<FieldCollection<Fields>>,
    /// A set of filter expressions to limit what data is returned
    pub filter: Option<FilterExpression<'a, Fields>>,
    /// The page number you want to display
    pub page: Option<i64>,
    /// The number of items you want to display on a page
    pub page_size: Option<i64>,
    /// A string of characters to seach for
    pub search: Option<&'a str>,
    /// The fields you want to sort on and the sort order, ascending or descending
    pub sort: Option<SortCollection<'a>>,
    /// The names of the children that you want to display
    pub nested_fields: Option<FieldCollection<Fields>>,
    /// The depth of children that you want to display. The maximum is 5.
    pub nested_fields_depth: Option<i64>,
    /// Disregard hierarchical classifications.
    pub flatten: Option<bool>,
    /// Restrict the fields to be returned by adding the field names to this
    /// collection
    pub fields: Option<FieldCollection<Fields>>,
}

impl<'a, Fields> PageParams<'a, Fields>
where
    Fields: Display,
{
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }
}

impl<'a, Fields> Default for PageParams<'a, Fields>
where
    Fields: Display,
{
    fn default() -> Self {
        Self {
            agregation_terms: None,
            filter: None,
            page: None,
            page_size: Default::default(),
            search: Default::default(),
            sort: None,
            nested_fields: None,
            nested_fields_depth: Default::default(),
            flatten: Default::default(),
            fields: None,
        }
    }
}