rama-http-headers 0.3.0

typed http headers for rama
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

use rama_http_types::{HeaderName, HeaderValue};

use crate::{Error, HeaderDecode, HeaderEncode, TypedHeader};

/// `Set-Cookie` header, defined [RFC6265](https://datatracker.ietf.org/doc/html/rfc6265#section-4.1)
///
/// The Set-Cookie HTTP response header is used to send cookies from the
/// server to the user agent.
///
/// Informally, the Set-Cookie response header contains the header name
/// "Set-Cookie" followed by a ":" and a cookie.  Each cookie begins with
/// a name-value-pair, followed by zero or more attribute-value pairs.
///
/// # ABNF
///
/// ```text
/// set-cookie-header = "Set-Cookie:" SP set-cookie-string
/// set-cookie-string = cookie-pair *( ";" SP cookie-av )
/// cookie-pair       = cookie-name "=" cookie-value
/// cookie-name       = token
/// cookie-value      = *cookie-octet / ( DQUOTE *cookie-octet DQUOTE )
/// cookie-octet      = %x21 / %x23-2B / %x2D-3A / %x3C-5B / %x5D-7E
///                       ; US-ASCII characters excluding CTLs,
///                       ; whitespace DQUOTE, comma, semicolon,
///                       ; and backslash
/// token             = <token, defined in [RFC2616], Section 2.2>
///
/// cookie-av         = expires-av / max-age-av / domain-av /
///                    path-av / secure-av / httponly-av /
///                     extension-av
/// expires-av        = "Expires=" sane-cookie-date
/// sane-cookie-date  = <rfc1123-date, defined in [RFC2616], Section 3.3.1>
/// max-age-av        = "Max-Age=" non-zero-digit *DIGIT
///                       ; In practice, both expires-av and max-age-av
///                       ; are limited to dates representable by the
///                       ; user agent.
/// non-zero-digit    = %x31-39
///                       ; digits 1 through 9
/// domain-av         = "Domain=" domain-value
/// domain-value      = <subdomain>
///                       ; defined in [RFC1034], Section 3.5, as
///                       ; enhanced by [RFC1123], Section 2.1
/// path-av           = "Path=" path-value
/// path-value        = <any CHAR except CTLs or ";">
/// secure-av         = "Secure"
/// httponly-av       = "HttpOnly"
/// extension-av      = <any CHAR except CTLs or ";">
/// ```
///
/// # Example values
///
/// * `SID=31d4d96e407aad42`
/// * `lang=en-US; Expires=Wed, 09 Jun 2021 10:18:14 GMT`
/// * `lang=; Expires=Sun, 06 Nov 1994 08:49:37 GMT`
/// * `lang=en-US; Path=/; Domain=example.com`
///
/// # Example
#[derive(Clone, Debug)]
pub struct SetCookie(Vec<HeaderValue>);

impl TypedHeader for SetCookie {
    fn name() -> &'static HeaderName {
        &::rama_http_types::header::SET_COOKIE
    }
}

// TODO: More powerful cookie API

impl SetCookie {
    #[inline]
    // TODO: this probbly will be removed soon...
    pub fn iter_header_values(&self) -> impl Iterator<Item = &HeaderValue> {
        self.0.iter()
    }
}

impl HeaderDecode for SetCookie {
    fn decode<'i, I: Iterator<Item = &'i HeaderValue>>(values: &mut I) -> Result<Self, Error> {
        let vec = values.cloned().collect::<Vec<_>>();

        if !vec.is_empty() {
            Ok(Self(vec))
        } else {
            Err(Error::invalid())
        }
    }
}

impl HeaderEncode for SetCookie {
    fn encode<E: Extend<HeaderValue>>(&self, values: &mut E) {
        values.extend(self.0.iter().cloned());
    }
}

#[cfg(test)]
mod tests {
    use super::super::{test_decode, test_encode};
    use super::*;

    #[test]
    fn decode() {
        let set_cookie = test_decode::<SetCookie>(&["foo=bar", "baz=quux"]).unwrap();
        assert_eq!(set_cookie.0.len(), 2);
        assert_eq!(set_cookie.0[0], "foo=bar");
        assert_eq!(set_cookie.0[1], "baz=quux");
    }

    #[test]
    fn encode() {
        let set_cookie = SetCookie(vec![
            HeaderValue::from_static("foo=bar"),
            HeaderValue::from_static("baz=quux"),
        ]);

        let headers = test_encode(set_cookie);
        let mut vals = headers.get_all("set-cookie").into_iter();
        assert_eq!(vals.next().unwrap(), "foo=bar");
        assert_eq!(vals.next().unwrap(), "baz=quux");
        assert_eq!(vals.next(), None);
    }
}