Struct HttpClientBuilder

pub struct HttpClientBuilder { /* private fields */ }

A HttpClientBuilder can be used to create a HttpClient with custom configuration.

Implementations

impl HttpClientBuilder

pub fn new() -> Self

Creates a new HttpClientBuilder.

This is the same as HttpClient::builder().

pub fn basic_auth<U, P>(self, username: U, password: Option<P>) -> Self

where U: Display, P: Display,

Enable basic authentication.

pub fn bearer_auth<T>(self, token: T) -> Self

where T: Display,

Enable bearer authentication.

pub fn header(self, name: HeaderName, value: HeaderValue) -> Self

Adds a Header for every request.

pub fn headers(self, headers: HeaderMap) -> Self

Adds Headers for every request.

pub fn timeout(self, timeout: Duration) -> Self

Enables a request timeout.

The timeout is applied from when the request starts connecting until the response body has finished.

Default is no timeout.

pub fn connect_timeout(self, timeout: Duration) -> Self

Set a timeout for only the connect phase of a Client.

Default is None.

pub fn build<U: Into<String>>( self, url: U, ) -> Result<HttpClient, HttpClientError>

Returns a HttpClient that uses this HttpClientBuilder configuration.

Trait Implementations

impl Debug for HttpClientBuilder

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

Formats the value using the given formatter.

impl Default for HttpClientBuilder

fn default() -> Self

Returns the “default value” for a type.