cogo_http/header/common/etag.rs
1use crate::header::EntityTag;
2
3header! {
4 /// `ETag` header, defined in [RFC7232](http://tools.ietf.org/html/rfc7232#section-2.3)
5 ///
6 /// The `ETag` header field in a response provides the current entity-tag
7 /// for the selected representation, as determined at the conclusion of
8 /// handling the request. An entity-tag is an opaque validator for
9 /// differentiating between multiple representations of the same
10 /// resource, regardless of whether those multiple representations are
11 /// due to resource state changes over time, content negotiation
12 /// resulting in multiple representations being valid at the same time,
13 /// or both. An entity-tag consists of an opaque quoted string, possibly
14 /// prefixed by a weakness indicator.
15 ///
16 /// # ABNF
17 /// ```plain
18 /// ETag = entity-tag
19 /// ```
20 ///
21 /// # Example values
22 /// * `"xyzzy"`
23 /// * `W/"xyzzy"`
24 /// * `""`
25 ///
26 /// # Examples
27 /// ```
28 /// use cogo_http::header::{Headers, ETag, EntityTag};
29 ///
30 /// let mut headers = Headers::new();
31 /// headers.set(ETag(EntityTag::new(false, "xyzzy".to_owned())));
32 /// ```
33 /// ```
34 /// use cogo_http::header::{Headers, ETag, EntityTag};
35 ///
36 /// let mut headers = Headers::new();
37 /// headers.set(ETag(EntityTag::new(true, "xyzzy".to_owned())));
38 /// ```
39 (ETag, "ETag") => [EntityTag]
40
41 test_etag {
42 // From the RFC
43 test_header!(test1,
44 vec![b"\"xyzzy\""],
45 Some(ETag(EntityTag::new(false, "xyzzy".to_owned()))));
46 test_header!(test2,
47 vec![b"W/\"xyzzy\""],
48 Some(ETag(EntityTag::new(true, "xyzzy".to_owned()))));
49 test_header!(test3,
50 vec![b"\"\""],
51 Some(ETag(EntityTag::new(false, "".to_owned()))));
52 // Own tests
53 test_header!(test4,
54 vec![b"\"foobar\""],
55 Some(ETag(EntityTag::new(false, "foobar".to_owned()))));
56 test_header!(test5,
57 vec![b"\"\""],
58 Some(ETag(EntityTag::new(false, "".to_owned()))));
59 test_header!(test6,
60 vec![b"W/\"weak-etag\""],
61 Some(ETag(EntityTag::new(true, "weak-etag".to_owned()))));
62 test_header!(test7,
63 vec![b"W/\"\x65\x62\""],
64 Some(ETag(EntityTag::new(true, "\u{0065}\u{0062}".to_owned()))));
65 test_header!(test8,
66 vec![b"W/\"\""],
67 Some(ETag(EntityTag::new(true, "".to_owned()))));
68 test_header!(test9,
69 vec![b"no-dquotes"],
70 None::<ETag>);
71 test_header!(test10,
72 vec![b"w/\"the-first-w-is-case-sensitive\""],
73 None::<ETag>);
74 test_header!(test11,
75 vec![b""],
76 None::<ETag>);
77 test_header!(test12,
78 vec![b"\"unmatched-dquotes1"],
79 None::<ETag>);
80 test_header!(test13,
81 vec![b"unmatched-dquotes2\""],
82 None::<ETag>);
83 test_header!(test14,
84 vec![b"matched-\"dquotes\""],
85 None::<ETag>);
86 }
87}
88
89bench_header!(bench, ETag, { vec![b"W/\"nonemptytag\"".to_vec()] });