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

use crate::model::Page;
use crate::request::stream::PageStream;
use crate::request::Endpoint;
use crate::request::RequestWithState;
use crate::result::Result;
use crate::util::to_json_response;
use reqwest::Method;
use serde::de::DeserializeOwned;

/// This trait marks a `Request` as `Paginated` and unlocks the
/// `Request::page()`, `Request::page_size()`, and `Request::stream()` methods.
///
/// For further reading please see
/// [the official API docs](https://developers.lexoffice.io/docs/#paging-of-resources)
pub trait Paginated {}

impl<T, S> RequestWithState<T, S>
where
    Self: Endpoint + Paginated + Sync + Send + Clone,
    T: DeserializeOwned + Sync + Send + Clone + 'static,
    S: Sync + Send + Clone,
{
    /// This method gets a page that contains items of type `T` from the API.
    /// It also allows to define a number of items to request per page.
    /// `RequestWithState<T, S>` must implement the `Paginated` trait in order to make
    /// this function available.
    pub async fn page_size(self, page: usize, size: usize) -> Result<Page<T>> {
        let mut url = self.url();
        url.query_pairs_mut()
            .append_pair("page", &page.to_string())
            .append_pair("size", &size.to_string());

        to_json_response(self.client().http_builder(Method::GET, url)).await
    }

    /// This method gets a page that contains items of type `T` from the API
    /// `RequestWithState<T, S>` must implement the `Paginated` trait in order to make
    /// this function available.
    pub async fn page(self, page: usize) -> Result<Page<T>> {
        let mut url = self.url();
        url.query_pairs_mut().append_pair("page", &page.to_string());

        to_json_response(self.client().http_builder(Method::GET, url)).await
    }

    /// Creates a `PageStream` from this request.
    pub fn stream(self) -> PageStream<T, S> {
        self.into()
    }
}