http_halforms 0.3.0

Support for HAL and HAL-FORMS responses in HTTP 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

mod link_hints;

pub use link_hints::*;
use serde::Serialize;

/// Representation of a single Link in a HAL document.
#[derive(Debug, Serialize)]
pub struct Link {
    pub href:        String,
    #[serde(skip_serializing_if = "is_false")]
    pub templated:   bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub r#type:      Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deprecation: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name:        Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub profile:     Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title:       Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hreflang:    Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hints:       Option<LinkHints>,
}

impl Link {
    /// Create a new Link with the given href.
    #[must_use]
    pub fn new<H>(href: H) -> Self
    where
        H: ToString,
    {
        Self {
            href:        href.to_string(),
            templated:   false,
            r#type:      None,
            deprecation: None,
            name:        None,
            profile:     None,
            title:       None,
            hreflang:    None,
            hints:       None,
        }
    }

    /// Indicate that the link is templated.
    #[must_use]
    pub fn templated(mut self) -> Self {
        self.templated = true;

        self
    }

    /// Specify the type value on the link.
    #[must_use]
    pub fn with_type<S>(mut self, value: S) -> Self
    where
        S: ToString,
    {
        self.r#type = Some(value.to_string());

        self
    }

    /// Specify the deprecation value on the link.
    #[must_use]
    pub fn with_deprecation<S>(mut self, value: S) -> Self
    where
        S: ToString,
    {
        self.deprecation = Some(value.to_string());

        self
    }

    /// Specify the name value on the link.
    #[must_use]
    pub fn with_name<S>(mut self, value: S) -> Self
    where
        S: ToString,
    {
        self.name = Some(value.to_string());

        self
    }

    /// Specify the profile value on the link.
    #[must_use]
    pub fn with_profile<S>(mut self, value: S) -> Self
    where
        S: ToString,
    {
        self.profile = Some(value.to_string());

        self
    }

    /// Specify the title value on the link.
    #[must_use]
    pub fn with_title<S>(mut self, value: S) -> Self
    where
        S: ToString,
    {
        self.title = Some(value.to_string());

        self
    }

    /// Specify the hreflang value on the link.
    #[must_use]
    pub fn with_hreflang<S>(mut self, value: S) -> Self
    where
        S: ToString,
    {
        self.hreflang = Some(value.to_string());

        self
    }

    /// Specify the hreflang value on the link.
    #[must_use]
    pub fn with_hints<V>(mut self, value: V) -> Self
    where
        V: Into<LinkHints>,
    {
        self.hints = Some(value.into());

        self
    }
}

impl<S> From<S> for Link
where
    S: ToString,
{
    fn from(href: S) -> Self {
        Self::new(href.to_string())
    }
}

#[allow(clippy::trivially_copy_pass_by_ref)] // Needed for Serde.
fn is_false(t: &bool) -> bool {
    t == &false
}