Example for RequestBuilder::headers

[dtolnay]

Remember that the point of examples is not always to show how to call the method, but to show why someone would want to call the method. Let's come up with an example showing a case where headers is more convenient than calling header multiple times.

[little-dude]

An example might be the github api. When using basic authentication, we need to send both the Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l header and the Accept header as they recommend.

Something that may look like this:

    use reqwest::header::{Headers, Basic, Accept, qitem, Authorization};
    use mime::{Mime, TopLevel, SubLevel};

    fn get_headers(username: &str, password: &str) -> Headers {
        let mut headers = Headers::new();

        // Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l
        headers.set(
            Authorization(
                Basic {
                    username: username.to_owned(),
                    password: Some(password.to_owned()),
                }));

        // Accept: application/vnd.github.v3+json
        headers.set(
            Accept(
                vec![
                qitem(
                    Mime(
                        TopLevel::Application,
                        SubLevel::Ext("vnd.github.v3.raw+json".to_owned()),
                        vec![]
                        ))]));

        headers
    }

    // then later:
    client
        .get("https://api.github.com/repos/octocat/Hello-World/issues/comments")
        .headers(get_headers("me", "qwerty123"))
        .send()?;

But maybe this is far fetched...

[brson]

Seems reasonable to me @little-dude.

[seanmonstar]

Fixed in #145