headers/common/
etag.rs

1use std::str::FromStr;
2
3use crate::util::EntityTag;
4
5/// `ETag` header, defined in [RFC7232](https://datatracker.ietf.org/doc/html/rfc7232#section-2.3)
6///
7/// The `ETag` header field in a response provides the current entity-tag
8/// for the selected representation, as determined at the conclusion of
9/// handling the request.  An entity-tag is an opaque validator for
10/// differentiating between multiple representations of the same
11/// resource, regardless of whether those multiple representations are
12/// due to resource state changes over time, content negotiation
13/// resulting in multiple representations being valid at the same time,
14/// or both.  An entity-tag consists of an opaque quoted string, possibly
15/// prefixed by a weakness indicator.
16///
17/// # ABNF
18///
19/// ```text
20/// ETag       = entity-tag
21/// ```
22///
23/// # Example values
24///
25/// * `"xyzzy"`
26/// * `W/"xyzzy"`
27/// * `""`
28///
29/// # Examples
30///
31/// ```
32/// let etag = "\"xyzzy\"".parse::<headers::ETag>().unwrap();
33/// ```
34#[derive(Clone, Debug, PartialEq, Eq)]
35pub struct ETag(pub(super) EntityTag);
36
37derive_header! {
38    ETag(_),
39    name: ETAG
40}
41
42impl ETag {
43    #[cfg(test)]
44    pub(crate) fn from_static(src: &'static str) -> ETag {
45        ETag(EntityTag::from_static(src))
46    }
47}
48
49error_type!(InvalidETag);
50
51impl FromStr for ETag {
52    type Err = InvalidETag;
53    fn from_str(src: &str) -> Result<Self, Self::Err> {
54        let val = src.parse().map_err(|_| InvalidETag { _inner: () })?;
55
56        EntityTag::from_owned(val)
57            .map(ETag)
58            .ok_or(InvalidETag { _inner: () })
59    }
60}
61
62/*
63test_etag {
64    // From the RFC
65    test_header!(test1,
66        vec![b"\"xyzzy\""],
67        Some(ETag(EntityTag::new(false, "xyzzy".to_owned()))));
68    test_header!(test2,
69        vec![b"W/\"xyzzy\""],
70        Some(ETag(EntityTag::new(true, "xyzzy".to_owned()))));
71    test_header!(test3,
72        vec![b"\"\""],
73        Some(ETag(EntityTag::new(false, "".to_owned()))));
74    // Own tests
75    test_header!(test4,
76        vec![b"\"foobar\""],
77        Some(ETag(EntityTag::new(false, "foobar".to_owned()))));
78    test_header!(test5,
79        vec![b"\"\""],
80        Some(ETag(EntityTag::new(false, "".to_owned()))));
81    test_header!(test6,
82        vec![b"W/\"weak-etag\""],
83        Some(ETag(EntityTag::new(true, "weak-etag".to_owned()))));
84    test_header!(test7,
85        vec![b"W/\"\x65\x62\""],
86        Some(ETag(EntityTag::new(true, "\u{0065}\u{0062}".to_owned()))));
87    test_header!(test8,
88        vec![b"W/\"\""],
89        Some(ETag(EntityTag::new(true, "".to_owned()))));
90    test_header!(test9,
91        vec![b"no-dquotes"],
92        None::<ETag>);
93    test_header!(test10,
94        vec![b"w/\"the-first-w-is-case-sensitive\""],
95        None::<ETag>);
96    test_header!(test11,
97        vec![b""],
98        None::<ETag>);
99    test_header!(test12,
100        vec![b"\"unmatched-dquotes1"],
101        None::<ETag>);
102    test_header!(test13,
103        vec![b"unmatched-dquotes2\""],
104        None::<ETag>);
105    test_header!(test14,
106        vec![b"matched-\"dquotes\""],
107        None::<ETag>);
108    test_header!(test15,
109        vec![b"\""],
110        None::<ETag>);
111}
112*/
headers/common/etag.rs

headers/common/
etag.rs
