Struct http_client::Config

#[non_exhaustive]
pub struct Config {
    pub http_keep_alive: bool,
    pub tcp_no_delay: bool,
    pub timeout: Option<Duration>,
    pub max_connections_per_host: usize,
    pub tls_config: Option<Arc<TlsConnector>>,
}

Configuration for HttpClients.

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.

http_keep_alive: bool

HTTP/1.1 keep-alive (connection pooling).

Default: true.

Note: Does nothing on wasm_client.

tcp_no_delay: bool

TCP NO_DELAY.

Default: false.

Note: Does nothing on wasm_client.

timeout: Option<Duration>

Connection timeout duration.

Default: Some(Duration::from_secs(60)).

max_connections_per_host: usize

Maximum number of simultaneous connections that this client is allowed to keep open to individual hosts at one time.

Default: 50. This number is based on a few random benchmarks and see whatever gave decent perf vs resource use in Orogene.

Note: The behavior of this is different depending on the backend in use.

• h1_client: 0 is disallowed and asserts as otherwise it would cause a semaphore deadlock.
• curl_client: 0 allows for limitless connections per host.
• hyper_client: No effect. Hyper does not support such an option.
• wasm_client: No effect. Web browsers do not support such an option.

tls_config: Option<Arc<TlsConnector>>

This is supported on crate feature h1_client only.

TLS Configuration (Native TLS)

Implementations

impl Config

pub fn new() -> Self

Construct new empty config.

impl Config

pub fn set_http_keep_alive(self, keep_alive: bool) -> Self

Set HTTP/1.1 keep-alive (connection pooling).

pub fn set_tcp_no_delay(self, no_delay: bool) -> Self

Set TCP NO_DELAY.

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

Set connection timeout duration.

pub fn set_max_connections_per_host(
    self,
    max_connections_per_host: usize
) -> Self

Set the maximum number of simultaneous connections that this client is allowed to keep open to individual hosts at one time.

pub fn set_tls_config(self, tls_config: Option<Arc<TlsConnector>>) -> Self

This is supported on crate feature h1_client only.

Set TLS Configuration (Native TLS)

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<Config> for IsahcClient

This is supported on crate feature curl_client only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(config: Config) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Config> for H1Client

This is supported on crate features h1_client and default only.

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(config: Config) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Config> for HyperClient

This is supported on crate feature hyper_client only.

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(config: Config) -> Result<Self, Self::Error>

Performs the conversion.