forked/reqwest-impersonate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Marked sensitive headers as such in docs (#1160)

Browse Source
This commit is contained in:
Mark Hildreth
2021-02-05 14:02:38 -05:00
committed by GitHub
parent 9ae11b26fc
commit 326b8a7769
2 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/async_impl/client.rs
View File

@@ -405,7 +405,12 @@ impl ClientBuilder {
/// use reqwest::header; /// use reqwest::header;
/// # async fn doc() -> Result<(), reqwest::Error> { /// # async fn doc() -> Result<(), reqwest::Error> {
/// let mut headers = header::HeaderMap::new(); /// let mut headers = header::HeaderMap::new();
/// headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret")); /// headers.insert("X-MY-HEADER", header::HeaderValue::from_static("value"));
///
/// // Consider marking security-sensitive headers with `set_sensitive`.
/// let mut auth_value = header::HeaderValue::from_static("secret");
/// auth_value.set_sensitive(true);
/// headers.insert(header::AUTHORIZATION, auth_value);
/// ///
/// // get a client builder /// // get a client builder
/// let client = reqwest::Client::builder() /// let client = reqwest::Client::builder()
@@ -422,7 +427,7 @@ impl ClientBuilder {
/// use reqwest::header; /// use reqwest::header;
/// # async fn doc() -> Result<(), reqwest::Error> { /// # async fn doc() -> Result<(), reqwest::Error> {
/// let mut headers = header::HeaderMap::new(); /// let mut headers = header::HeaderMap::new();
/// headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret")); /// headers.insert("X-MY-HEADER", header::HeaderValue::from_static("value"));
/// ///
/// // get a client builder /// // get a client builder
/// let client = reqwest::Client::builder() /// let client = reqwest::Client::builder()
@@ -430,7 +435,7 @@ impl ClientBuilder {
/// .build()?; /// .build()?;
/// let res = client /// let res = client
/// .get("https://www.rust-lang.org") /// .get("https://www.rust-lang.org")
/// .header(header::AUTHORIZATION, "token") /// .header("X-MY-HEADER", "new_value")
/// .send() /// .send()
/// .await?; /// .await?;
/// # Ok(()) /// # Ok(())

10
src/blocking/client.rs
View File

@@ -141,8 +141,14 @@ impl ClientBuilder {
/// use reqwest::header; /// use reqwest::header;
/// # fn build_client() -> Result<(), reqwest::Error> { /// # fn build_client() -> Result<(), reqwest::Error> {
/// let mut headers = header::HeaderMap::new(); /// let mut headers = header::HeaderMap::new();
/// headers.insert("X-MY-HEADER", header::HeaderValue::from_static("value"));
/// headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret")); /// headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret"));
/// ///
/// // Consider marking security-sensitive headers with `set_sensitive`.
/// let mut auth_value = header::HeaderValue::from_static("secret");
/// auth_value.set_sensitive(true);
/// headers.insert(header::AUTHORIZATION, auth_value);
///
/// // get a client builder /// // get a client builder
/// let client = reqwest::blocking::Client::builder() /// let client = reqwest::blocking::Client::builder()
/// .default_headers(headers) /// .default_headers(headers)
@@ -158,7 +164,7 @@ impl ClientBuilder {
/// use reqwest::header; /// use reqwest::header;
/// # fn build_client() -> Result<(), reqwest::Error> { /// # fn build_client() -> Result<(), reqwest::Error> {
/// let mut headers = header::HeaderMap::new(); /// let mut headers = header::HeaderMap::new();
/// headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret")); /// headers.insert("X-MY-HEADER", header::HeaderValue::from_static("value"));
/// ///
/// // get a client builder /// // get a client builder
/// let client = reqwest::blocking::Client::builder() /// let client = reqwest::blocking::Client::builder()
@@ -166,7 +172,7 @@ impl ClientBuilder {
/// .build()?; /// .build()?;
/// let res = client /// let res = client
/// .get("https://www.rust-lang.org") /// .get("https://www.rust-lang.org")
/// .header(header::AUTHORIZATION, "token") /// .header("X-MY-HEADER", "new_value")
/// .send()?; /// .send()?;
/// # Ok(()) /// # Ok(())
/// # } /// # }