Struct reqwest::ClientBuilder

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

pub fn new() -> Result<ClientBuilder>

Constructs a new ClientBuilder

Errors

This method fails if native TLS backend cannot be created.

pub fn build(&mut self) -> Result<Client>

Returns a Client that uses this ClientBuilder configuration.

Errors

This method fails if native TLS backend cannot be initialized.

Panics

This method consumes the internal state of the builder. Trying to use this builder again after calling build will panic.

pub fn add_root_certificate(
    &mut self,
    cert: Certificate
) -> Result<&mut 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::ClientBuilder::new()?
    .add_root_certificate(cert)?
    .build()?;

Errors

This method fails if adding root certificate was unsuccessful.

pub fn danger_disable_hostname_verification(&mut self) -> &mut ClientBuilder

Disable hostname verification.

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 enable_hostname_verification(&mut self) -> &mut ClientBuilder

Enable hostname verification.

Default is enabled.

pub fn gzip(&mut self, enable: bool) -> &mut ClientBuilder

Enable auto gzip decompression by checking the ContentEncoding response header.

Default is enabled.

pub fn proxy(&mut self, proxy: Proxy) -> &mut ClientBuilder

Add a Proxy to the list of proxies the Client will use.

pub fn redirect(&mut self, policy: RedirectPolicy) -> &mut ClientBuilder

Set a RedirectPolicy for this client.

Default will follow redirects up to a maximum of 10.

pub fn referer(&mut self, enable: bool) -> &mut ClientBuilder

Enable or disable automatic setting of the Referer header.

Default is true.

pub fn timeout(&mut self, timeout: Duration) -> &mut ClientBuilder

Set a timeout for connect, read and write operations of a Client.

Trait Implementations

impl Debug for ClientBuilder

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.