freedom-models 3.1.0

Models for the Freedom API
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

use std::collections::HashMap;

use crate::Hateoas;

use super::utils;
use serde::{Deserialize, Serialize, de::DeserializeOwned};
use url::Url;

/// A paginated response
#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
pub struct Paginated<T>
where
    T: DeserializeOwned,
{
    #[serde(rename = "_embedded")]
    #[serde(deserialize_with = "utils::destructure::serde::deserialize")]
    pub items: Vec<T>,
    #[serde(rename = "_links")]
    #[serde(with = "utils::links::serde")]
    pub links: HashMap<String, Url>,
    pub page: Page,
}

impl<T> Hateoas for Paginated<T>
where
    T: DeserializeOwned,
{
    fn get_links(&self) -> &HashMap<String, url::Url> {
        &self.links
    }

    fn get_links_mut(&mut self) -> &mut HashMap<String, url::Url> {
        &mut self.links
    }
}

/// Page metadata included in a paginated stream
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[serde(rename_all = "camelCase")]
#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
pub struct Page {
    pub size: u32,
    pub total_elements: u32,
    pub total_pages: u32,
    pub number: u32,
}