Struct HttpClientConfig

#[non_exhaustive]
pub struct HttpClientConfig {

    pub client_cert: Option<Box<Path>>,
    pub connect_timeout: Option<Duration>,
    pub read_timeout: Option<Duration>,
    pub request_timeout: Option<Duration>,
    pub pool_idle_timeout: Option<Duration>,
    pub pool_max_idle_per_host: usize,
    pub verbose: bool,
    pub extra_headers: BTreeMap<String, String>,
    pub redirect: HttpClientRedirectPolicy,
    pub referer: bool,
    pub tcp: HttpClientTcpConfig,
    pub http2: HttpClientHttp2Config,
    pub cb: Option<HttpClientCircuitBreakerConfig>,
    /* private fields */
}

HTTP client configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_cert: Option<Box<Path>>

Path to PEM-formatted file containing a private key and at least one client certificate.

connect_timeout: Option<Duration>

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

Default is None.

read_timeout: Option<Duration>

Enables a read timeout.

The timeout applies to each read operation, and resets after a successful read. This is more appropriate for detecting stalled connections when the size isn’t known beforehand.

Default is no timeout.

request_timeout: Option<Duration>

Enables a total request timeout.

The timeout is applied from when the request starts connecting until the response body has finished. Also considered a total deadline.

Default is no timeout.

pool_idle_timeout: Option<Duration>

Set an optional timeout for idle sockets being kept-alive.

Set to None to disable timeout.

Default is 90 seconds.

pool_max_idle_per_host: usize

Sets the maximum idle connection per host allowed in the pool.

verbose: bool

Set whether connections should emit verbose logs.

Enabling this option will emit log messages at the TRACE level for read and write operations on connections.

extra_headers: BTreeMap<String, String>

Sets the default headers for every request.

redirect: HttpClientRedirectPolicy

Set a redirect policy for this client.

Default will follow redirects up to a maximum of 10.

referer: bool

Enable or disable automatic setting of the Referer header.

Default is true.

tcp: HttpClientTcpConfig

TCP-level configuration.

http2: HttpClientHttp2Config

HTTP/2 protocol configuration.

cb: Option<HttpClientCircuitBreakerConfig>

Circuit breaker configuration.

Implementations

impl HttpClientConfig

pub fn with_app_name(&mut self, app_name: impl ToString) -> &mut Self

Set short name of an application.

Whitespace is not allowed, as this value is used in User-Agent: HTTP header, among other things.

pub fn with_app_version(&mut self, app_version: impl ToString) -> &mut Self

Set application version.

Preferably in semver format. Whitespace is not allowed, as this value is used in Server: HTTP header, among other things.

pub async fn to_client_builder(&self) -> Result<ClientBuilder, HttpClientError>

Create reqwest::ClientBuilder from configuration.

Errors

Returns Err if:

• Some client configuration is invalid.
• Unable to load TLS identity file(s) from filesystem.

pub fn build_client( &self, builder: ClientBuilder, metrics: Option<ClientMetricsState>, ) -> Result<ClientWithMiddleware, HttpClientError>

Convert passed client builder into client with all necessary middlewares attached.

Errors

Returns Err if:

• TLS subsystem cannot be initialized.
• DNS resolver fails to load its configuration.

pub async fn to_client( &self, metrics: Option<ClientMetricsState>, ) -> Result<ClientWithMiddleware, HttpClientError>

Build and return configured reqwest HTTP client.

Errors

Returns Err if:

• Some client configuration is invalid.
• Unable to load TLS identity file(s) from filesystem.
• TLS subsystem cannot be initialized.
• DNS resolver fails to load its configuration.

Trait Implementations

impl Clone for HttpClientConfig

fn clone(&self) -> HttpClientConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpClientConfig

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

Formats the value using the given formatter.

impl Default for HttpClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HttpClientConfig

fn eq(&self, other: &HttpClientConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HttpClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HttpClientConfig