Skip to content

Commit febf303

Browse files
seanmonstarseanmonstar
committed
Merge pull request #567 from clatour/header-docs
docs(headers): add examples
2 parents c37d857 + c940e84 commit febf303

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+856
-0
lines changed

‎src/header/common/accept.rs

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,51 @@ header! {
2727
#[doc="* `audio/*; q=0.2, audio/basic` (`*` value won't parse correctly)"]
2828
#[doc="* `text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c`"]
2929
#[doc=""]
30+
#[doc="# Examples"]
31+
#[doc="```"]
32+
#[doc="use hyper::header::{Headers, Accept, qitem};"]
33+
#[doc="use hyper::mime::{Mime, TopLevel, SubLevel};"]
34+
#[doc=""]
35+
#[doc="let mut headers = Headers::new();"]
36+
#[doc=""]
37+
#[doc="headers.set("]
38+
#[doc=" Accept(vec!["]
39+
#[doc=" qitem(Mime(TopLevel::Text, SubLevel::Html, vec![])),"]
40+
#[doc=" ])"]
41+
#[doc=");"]
42+
#[doc="```"]
43+
#[doc="```"]
44+
#[doc="use hyper::header::{Headers, Accept, qitem};"]
45+
#[doc="use hyper::mime::{Mime, TopLevel, SubLevel, Attr, Value};"]
46+
#[doc=""]
47+
#[doc="let mut headers = Headers::new();"]
48+
#[doc="headers.set("]
49+
#[doc=" Accept(vec!["]
50+
#[doc=" qitem(Mime(TopLevel::Application, SubLevel::Json,"]
51+
#[doc=" vec![(Attr::Charset, Value::Utf8)])),"]
52+
#[doc=" ])"]
53+
#[doc=");"]
54+
#[doc="```"]
55+
#[doc="```"]
56+
#[doc="use hyper::header::{Headers, Accept, QualityItem, Quality, qitem};"]
57+
#[doc="use hyper::mime::{Mime, TopLevel, SubLevel};"]
58+
#[doc=""]
59+
#[doc="let mut headers = Headers::new();"]
60+
#[doc=""]
61+
#[doc="headers.set("]
62+
#[doc=" Accept(vec!["]
63+
#[doc=" qitem(Mime(TopLevel::Text, SubLevel::Html, vec![])),"]
64+
#[doc=" qitem(Mime(TopLevel::Application, SubLevel::Ext(\"xhtml+xml\".to_owned()), vec![])),"]
65+
#[doc=" QualityItem::new(Mime(TopLevel::Application, SubLevel::Xml, vec![]),"]
66+
#[doc=" Quality(900)),"]
67+
#[doc=" qitem(Mime(TopLevel::Image, SubLevel::Ext(\"webp\".to_owned()), vec![])),
68+
"]
69+
#[doc=" QualityItem::new(Mime(TopLevel::Star, SubLevel::Star, vec![]),"]
70+
#[doc=" Quality(800))"]
71+
#[doc=" ])"]
72+
#[doc=");"]
73+
#[doc="```"]
74+
#[doc=""]
3075
#[doc="# Notes"]
3176
#[doc="* Using always Mime types to represent `media-range` differs from the ABNF."]
3277
#[doc="* **FIXME**: `accept-ext` is not supported."]

‎src/header/common/accept_charset.rs

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,35 @@ header! {
1818
#[doc=""]
1919
#[doc="# Example values"]
2020
#[doc="* `iso-8859-5, unicode-1-1;q=0.8`"]
21+
#[doc=""]
22+
#[doc="# Examples"]
23+
#[doc="```"]
24+
#[doc="use hyper::header::{Headers, AcceptCharset, Charset, qitem};"]
25+
#[doc=""]
26+
#[doc="let mut headers = Headers::new();"]
27+
#[doc="headers.set("]
28+
#[doc=" AcceptCharset(vec![qitem(Charset::Us_Ascii)])"]
29+
#[doc=");"]
30+
#[doc="```"]
31+
#[doc="```"]
32+
#[doc="use hyper::header::{Headers, AcceptCharset, Charset, Quality, QualityItem};"]
33+
#[doc=""]
34+
#[doc="let mut headers = Headers::new();"]
35+
#[doc="headers.set("]
36+
#[doc=" AcceptCharset(vec!["]
37+
#[doc=" QualityItem::new(Charset::Us_Ascii, Quality(900)),"]
38+
#[doc=" QualityItem::new(Charset::Iso_8859_10, Quality(200)),"]
39+
#[doc=" ])"]
40+
#[doc=");"]
41+
#[doc="```"]
42+
#[doc="```"]
43+
#[doc="use hyper::header::{Headers, AcceptCharset, Charset, qitem};"]
44+
#[doc=""]
45+
#[doc="let mut headers = Headers::new();"]
46+
#[doc="headers.set("]
47+
#[doc=" AcceptCharset(vec![qitem(Charset::Ext(\"utf-8\".to_owned()))])"]
48+
#[doc=");"]
49+
#[doc="```"]
2150
(AcceptCharset, "Accept-Charset") => (QualityItem<Charset>)+
2251

2352
test_accept_charset {

‎src/header/common/accept_encoding.rs

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,40 @@ header! {
2222
#[doc="* `*`"]
2323
#[doc="* `compress;q=0.5, gzip;q=1`"]
2424
#[doc="* `gzip;q=1.0, identity; q=0.5, *;q=0`"]
25+
#[doc=""]
26+
#[doc="# Examples"]
27+
#[doc="```"]
28+
#[doc="use hyper::header::{Headers, AcceptEncoding, Encoding, qitem};"]
29+
#[doc=""]
30+
#[doc="let mut headers = Headers::new();"]
31+
#[doc="headers.set("]
32+
#[doc=" AcceptEncoding(vec![qitem(Encoding::Chunked)])"]
33+
#[doc=");"]
34+
#[doc="```"]
35+
#[doc="```"]
36+
#[doc="use hyper::header::{Headers, AcceptEncoding, Encoding, qitem};"]
37+
#[doc=" "]
38+
#[doc="let mut headers = Headers::new();"]
39+
#[doc="headers.set("]
40+
#[doc=" AcceptEncoding(vec!["]
41+
#[doc=" qitem(Encoding::Chunked),"]
42+
#[doc=" qitem(Encoding::Gzip),"]
43+
#[doc=" qitem(Encoding::Deflate),"]
44+
#[doc=" ])"]
45+
#[doc=");"]
46+
#[doc="```"]
47+
#[doc="```"]
48+
#[doc="use hyper::header::{Headers, AcceptEncoding, Encoding, QualityItem, Quality, qitem};"]
49+
#[doc=" "]
50+
#[doc="let mut headers = Headers::new();"]
51+
#[doc="headers.set("]
52+
#[doc=" AcceptEncoding(vec!["]
53+
#[doc=" qitem(Encoding::Chunked),"]
54+
#[doc=" QualityItem::new(Encoding::Gzip, Quality(600)),"]
55+
#[doc=" QualityItem::new(Encoding::EncodingExt(\"*\".to_owned()), Quality(0)),"]
56+
#[doc=" ])"]
57+
#[doc=");"]
58+
#[doc="```"]
2559
(AcceptEncoding, "Accept-Encoding") => (QualityItem<Encoding>)*
2660

2761
test_accept_encoding {

‎src/header/common/accept_language.rs

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,52 @@ header! {
1717
#[doc="# Example values"]
1818
#[doc="* `da, en-gb;q=0.8, en;q=0.7`"]
1919
#[doc="* `en-us;q=1.0, en;q=0.5, fr`"]
20+
#[doc=""]
21+
#[doc="# Examples"]
22+
#[doc="```"]
23+
#[doc="use hyper::header::{Headers, AcceptLanguage, Language, qitem};"]
24+
#[doc=""]
25+
#[doc="let mut headers = Headers::new();"]
26+
#[doc="headers.set("]
27+
#[doc=" AcceptLanguage(vec!["]
28+
#[doc=" qitem("]
29+
#[doc=" Language {"]
30+
#[doc=" primary: \"en\".to_owned(),"]
31+
#[doc=" sub: Some(\"us\".to_owned()),"]
32+
#[doc=" }"]
33+
#[doc=" ),"]
34+
#[doc=" ])"]
35+
#[doc=");"]
36+
#[doc="```"]
37+
#[doc="```"]
38+
#[doc="use hyper::header::{Headers, AcceptLanguage, Language, QualityItem, Quality, qitem};"]
39+
#[doc=""]
40+
#[doc="let mut headers = Headers::new();"]
41+
#[doc="headers.set("]
42+
#[doc=" AcceptLanguage(vec!["]
43+
#[doc=" qitem("]
44+
#[doc=" Language {"]
45+
#[doc=" primary: \"da\".to_owned(),"]
46+
#[doc=" sub: None,"]
47+
#[doc=" }"]
48+
#[doc=" ),"]
49+
#[doc=" QualityItem::new("]
50+
#[doc=" Language {"]
51+
#[doc=" primary: \"en\".to_owned(),"]
52+
#[doc=" sub: Some(\"gb\".to_owned()),"]
53+
#[doc=" },"]
54+
#[doc=" Quality(800),"]
55+
#[doc=" ),"]
56+
#[doc=" QualityItem::new("]
57+
#[doc=" Language {"]
58+
#[doc=" primary: \"en\".to_owned(),"]
59+
#[doc=" sub: None,"]
60+
#[doc=" },"]
61+
#[doc=" Quality(700),"]
62+
#[doc=" ),"]
63+
#[doc=" ])"]
64+
#[doc=");"]
65+
#[doc="```"]
2066
(AcceptLanguage, "Accept-Language") => (QualityItem<Language>)+
2167

2268
test_accept_language {

‎src/header/common/accept_ranges.rs

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,33 @@ header! {
1818
#[doc="* `none`"]
1919
#[doc="* `unknown-unit`"]
2020
#[doc="```"]
21+
#[doc=""]
22+
#[doc="# Examples"]
23+
#[doc="```"]
24+
#[doc="use hyper::header::{Headers, AcceptRanges, RangeUnit};"]
25+
#[doc=""]
26+
#[doc="let mut headers = Headers::new();"]
27+
#[doc="headers.set(AcceptRanges(vec![RangeUnit::Bytes]));"]
28+
#[doc="```"]
29+
#[doc="```"]
30+
#[doc="use hyper::header::{Headers, AcceptRanges, RangeUnit};"]
31+
#[doc=""]
32+
#[doc="let mut headers = Headers::new();"]
33+
#[doc="headers.set(AcceptRanges(vec![RangeUnit::None]));"]
34+
#[doc="```"]
35+
#[doc="```"]
36+
#[doc="use hyper::header::{Headers, AcceptRanges, RangeUnit};"]
37+
#[doc=""]
38+
#[doc="let mut headers = Headers::new();"]
39+
#[doc="headers.set("]
40+
#[doc=" AcceptRanges(vec!["]
41+
#[doc=" RangeUnit::Unregistered(\"nibbles\".to_owned()),"]
42+
#[doc=" RangeUnit::Bytes,"]
43+
#[doc=" RangeUnit::Unregistered(\"doublets\".to_owned()),"]
44+
#[doc=" RangeUnit::Unregistered(\"quadlets\".to_owned()),"]
45+
#[doc=" ])"]
46+
#[doc=");"]
47+
#[doc="```"]
2148
(AcceptRanges, "Accept-Ranges") => (RangeUnit)+
2249

2350
test_acccept_ranges {

‎src/header/common/access_control_allow_headers.rs

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,41 @@ header! {
1515
#[doc=""]
1616
#[doc="# Example values"]
1717
#[doc="* `accept-language, date`"]
18+
#[doc=""]
19+
#[doc="# Examples"]
20+
#[doc="```"]
21+
#[doc="# extern crate hyper;"]
22+
#[doc="# extern crate unicase;"]
23+
#[doc="# fn main() {"]
24+
#[doc="// extern crate unicase;"]
25+
#[doc=""]
26+
#[doc="use hyper::header::{Headers, AccessControlAllowHeaders};"]
27+
#[doc="use unicase::UniCase;"]
28+
#[doc=""]
29+
#[doc="let mut headers = Headers::new();"]
30+
#[doc="headers.set("]
31+
#[doc=" AccessControlAllowHeaders(vec![UniCase(\"date\".to_owned())])"]
32+
#[doc=");"]
33+
#[doc="# }"]
34+
#[doc="```"]
35+
#[doc="```"]
36+
#[doc="# extern crate hyper;"]
37+
#[doc="# extern crate unicase;"]
38+
#[doc="# fn main() {"]
39+
#[doc="// extern crate unicase;"]
40+
#[doc=""]
41+
#[doc="use hyper::header::{Headers, AccessControlAllowHeaders};"]
42+
#[doc="use unicase::UniCase;"]
43+
#[doc=""]
44+
#[doc="let mut headers = Headers::new();"]
45+
#[doc="headers.set("]
46+
#[doc=" AccessControlAllowHeaders(vec!["]
47+
#[doc=" UniCase(\"accept-language\".to_owned()),"]
48+
#[doc=" UniCase(\"date\".to_owned()),"]
49+
#[doc=" ])"]
50+
#[doc=");"]
51+
#[doc="# }"]
52+
#[doc="```"]
1853
(AccessControlAllowHeaders, "Access-Control-Allow-Headers") => (UniCase<String>)*
1954

2055
test_access_control_allow_headers {

‎src/header/common/access_control_allow_methods.rs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,31 @@ header! {
1515
#[doc=""]
1616
#[doc="# Example values"]
1717
#[doc="* `PUT, DELETE, XMODIFY`"]
18+
#[doc=""]
19+
#[doc="# Examples"]
20+
#[doc="```"]
21+
#[doc="use hyper::header::{Headers, AccessControlAllowMethods};"]
22+
#[doc="use hyper::method::Method;"]
23+
#[doc=""]
24+
#[doc="let mut headers = Headers::new();"]
25+
#[doc="headers.set("]
26+
#[doc=" AccessControlAllowMethods(vec![Method::Get])"]
27+
#[doc=");"]
28+
#[doc="```"]
29+
#[doc="```"]
30+
#[doc="use hyper::header::{Headers, AccessControlAllowMethods};"]
31+
#[doc="use hyper::method::Method;"]
32+
#[doc=""]
33+
#[doc="let mut headers = Headers::new();"]
34+
#[doc="headers.set("]
35+
#[doc=" AccessControlAllowMethods(vec!["]
36+
#[doc=" Method::Get,"]
37+
#[doc=" Method::Post,"]
38+
#[doc=" Method::Patch,"]
39+
#[doc=" Method::Extension(\"COPY\".to_owned()),"]
40+
#[doc=" ])"]
41+
#[doc=");"]
42+
#[doc="```"]
1843
(AccessControlAllowMethods, "Access-Control-Allow-Methods") => (Method)*
1944

2045
test_access_control_allow_methods {

‎src/header/common/access_control_allow_origin.rs

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,33 @@ use header::{Header, HeaderFormat};
2020
/// * `null`
2121
/// * `*`
2222
/// * `http://google.com/`
23+
///
24+
/// # Examples
25+
/// ```
26+
/// use hyper::header::{Headers, AccessControlAllowOrigin};
27+
///
28+
/// let mut headers = Headers::new();
29+
/// headers.set(
30+
/// AccessControlAllowOrigin::Any
31+
/// );
32+
/// ```
33+
/// ```
34+
/// use hyper::header::{Headers, AccessControlAllowOrigin};
35+
///
36+
/// let mut headers = Headers::new();
37+
/// headers.set(
38+
/// AccessControlAllowOrigin::Null,
39+
/// );
40+
/// ```
41+
/// ```
42+
/// use hyper::header::{Headers, AccessControlAllowOrigin};
43+
/// use hyper::Url;
44+
///
45+
/// let mut headers = Headers::new();
46+
/// headers.set(
47+
/// AccessControlAllowOrigin::Value(Url::parse("http://hyper.rs").unwrap())
48+
/// );
49+
/// ```
2350
#[derive(Clone, PartialEq, Debug)]
2451
pub enum AccessControlAllowOrigin {
2552
/// Allow all origins

‎src/header/common/access_control_max_age.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ header! {
1212
#[doc=""]
1313
#[doc="# Example values"]
1414
#[doc="* `531`"]
15+
#[doc=""]
16+
#[doc="# Examples"]
17+
#[doc="```"]
18+
#[doc="use hyper::header::{Headers, AccessControlMaxAge};"]
19+
#[doc=""]
20+
#[doc="let mut headers = Headers::new();"]
21+
#[doc="headers.set(AccessControlMaxAge(1728000u32));"]
22+
#[doc="```"]
1523
(AccessControlMaxAge, "Access-Control-Max-Age") => [u32]
1624

1725
test_access_control_max_age {

‎src/header/common/access_control_request_headers.rs

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,41 @@ header! {
1515
#[doc=""]
1616
#[doc="# Example values"]
1717
#[doc="* `accept-language, date`"]
18+
#[doc=""]
19+
#[doc="# Examples"]
20+
#[doc="```"]
21+
#[doc="# extern crate hyper;"]
22+
#[doc="# extern crate unicase;"]
23+
#[doc="# fn main() {"]
24+
#[doc="// extern crate unicase;"]
25+
#[doc=""]
26+
#[doc="use hyper::header::{Headers, AccessControlRequestHeaders};"]
27+
#[doc="use unicase::UniCase;"]
28+
#[doc=""]
29+
#[doc="let mut headers = Headers::new();"]
30+
#[doc="headers.set("]
31+
#[doc=" AccessControlRequestHeaders(vec![UniCase(\"date\".to_owned())])"]
32+
#[doc=");"]
33+
#[doc="# }"]
34+
#[doc="```"]
35+
#[doc="```"]
36+
#[doc="# extern crate hyper;"]
37+
#[doc="# extern crate unicase;"]
38+
#[doc="# fn main() {"]
39+
#[doc="// extern crate unicase;"]
40+
#[doc=""]
41+
#[doc="use hyper::header::{Headers, AccessControlRequestHeaders};"]
42+
#[doc="use unicase::UniCase;"]
43+
#[doc=""]
44+
#[doc="let mut headers = Headers::new();"]
45+
#[doc="headers.set("]
46+
#[doc=" AccessControlRequestHeaders(vec!["]
47+
#[doc=" UniCase(\"accept-language\".to_owned()),"]
48+
#[doc=" UniCase(\"date\".to_owned()),"]
49+
#[doc=" ])"]
50+
#[doc=");"]
51+
#[doc="# }"]
52+
#[doc="```"]
1853
(AccessControlRequestHeaders, "Access-Control-Request-Headers") => (UniCase<String>)*
1954

2055
test_access_control_request_headers {

‎src/header/common/access_control_request_method.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ header! {
1313
#[doc=""]
1414
#[doc="# Example values"]
1515
#[doc="* `GET`"]
16+
#[doc=""]
17+
#[doc="# Examples"]
18+
#[doc="```"]
19+
#[doc="use hyper::header::{Headers, AccessControlRequestMethod};"]
20+
#[doc="use hyper::method::Method;"]
21+
#[doc=""]
22+
#[doc="let mut headers = Headers::new();"]
23+
#[doc="headers.set(AccessControlRequestMethod(Method::Get));"]
24+
#[doc="```"]
1625
(AccessControlRequestMethod, "Access-Control-Request-Method") => [Method]
1726

1827
test_access_control_request_method {

0 commit comments

Comments
 (0)