Struct reqwest::ClientBuilder [−][src]
pub struct ClientBuilder { /* fields omitted */ }
A ClientBuilder
can be used to create a Client
with custom configuration.
Example
use std::time::Duration; let client = reqwest::Client::builder() .gzip(true) .timeout(Duration::from_secs(10)) .build()?;
Methods
impl ClientBuilder
[src]
impl ClientBuilder
pub fn new() -> ClientBuilder
[src]
pub fn new() -> ClientBuilder
Constructs a new ClientBuilder
pub fn build(self) -> Result<Client>
[src]
pub fn build(self) -> Result<Client>
Returns a Client
that uses this ClientBuilder
configuration.
Errors
This method fails if native TLS backend cannot be initialized.
pub fn add_root_certificate(self, cert: Certificate) -> ClientBuilder
[src]
pub fn add_root_certificate(self, cert: Certificate) -> ClientBuilder
Add a custom root certificate.
This can be used to connect to a server that has a self-signed certificate for example.
Example
// read a local binary DER encoded certificate let mut buf = Vec::new(); File::open("my-cert.der")?.read_to_end(&mut buf)?; // create a certificate let cert = reqwest::Certificate::from_der(&buf)?; // get a client builder let client = reqwest::Client::builder() .add_root_certificate(cert) .build()?;
Errors
This method fails if adding root certificate was unsuccessful.
pub fn identity(self, identity: Identity) -> ClientBuilder
[src]
pub fn identity(self, identity: Identity) -> ClientBuilder
Sets the identity to be used for client certificate authentication.
Example
// read a local PKCS12 bundle let mut buf = Vec::new(); File::open("my-ident.pfx")?.read_to_end(&mut buf)?; // create an Identity from the PKCS#12 archive let pkcs12 = reqwest::Identity::from_pkcs12_der(&buf, "my-privkey-password")?; // get a client builder let client = reqwest::Client::builder() .identity(pkcs12) .build()?;
pub fn danger_accept_invalid_hostnames(
self,
accept_invalid_hostname: bool
) -> ClientBuilder
[src]
pub fn danger_accept_invalid_hostnames(
self,
accept_invalid_hostname: bool
) -> ClientBuilder
Controls the use of hostname verification.
Defaults to false
.
Warning
You should think very carefully before you use this method. If hostname verification is not used, any valid certificate for any site will be trusted for use from any other. This introduces a significant vulnerability to man-in-the-middle attacks.
pub fn danger_accept_invalid_certs(
self,
accept_invalid_certs: bool
) -> ClientBuilder
[src]
pub fn danger_accept_invalid_certs(
self,
accept_invalid_certs: bool
) -> ClientBuilder
Controls the use of certificate validation.
Defaults to false
.
Warning
You should think very carefully before using this method. If invalid certificates are trusted, any certificate for any site will be trusted for use. This includes expired certificates. This introduces significant vulnerabilities, and should only be used as a last resort.
pub fn default_headers(self, headers: HeaderMap) -> ClientBuilder
[src]
pub fn default_headers(self, headers: HeaderMap) -> ClientBuilder
Sets the default headers for every request.
Example
use reqwest::header; let mut headers = header::HeaderMap::new(); headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret")); // get a client builder let client = reqwest::Client::builder() .default_headers(headers) .build()?; let res = client.get("https://www.rust-lang.org").send()?;
Override the default headers:
use reqwest::header; let mut headers = header::HeaderMap::new(); headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret")); // get a client builder let client = reqwest::Client::builder() .default_headers(headers) .build()?; let res = client .get("https://www.rust-lang.org") .header(header::AUTHORIZATION, "token") .send()?;
pub fn gzip(self, enable: bool) -> ClientBuilder
[src]
pub fn gzip(self, enable: bool) -> ClientBuilder
Enable auto gzip decompression by checking the ContentEncoding response header.
Default is enabled.
pub fn proxy(self, proxy: Proxy) -> ClientBuilder
[src]
pub fn proxy(self, proxy: Proxy) -> ClientBuilder
Add a Proxy
to the list of proxies the Client
will use.
pub fn redirect(self, policy: RedirectPolicy) -> ClientBuilder
[src]
pub fn redirect(self, policy: RedirectPolicy) -> ClientBuilder
Set a RedirectPolicy
for this client.
Default will follow redirects up to a maximum of 10.
pub fn referer(self, enable: bool) -> ClientBuilder
[src]
pub fn referer(self, enable: bool) -> ClientBuilder
Enable or disable automatic setting of the Referer
header.
Default is true
.
pub fn timeout<T>(self, timeout: T) -> ClientBuilder where
T: Into<Option<Duration>>,
[src]
pub fn timeout<T>(self, timeout: T) -> ClientBuilder where
T: Into<Option<Duration>>,
Set a timeout for connect, read and write operations of a Client
.
Default is 30 seconds.
Pass None
to disable timeout.
Trait Implementations
impl Debug for ClientBuilder
[src]
impl Debug for ClientBuilder
Auto Trait Implementations
impl Send for ClientBuilder
impl Send for ClientBuilder
impl Sync for ClientBuilder
impl Sync for ClientBuilder