Struct HttpClientOptions 

pub struct HttpClientOptions {

    pub base_url: Option<Url>,
    pub default_headers: HeaderMap,
    pub timeouts: HttpTimeoutOptions,
    pub proxy: ProxyOptions,
    pub logging: HttpLoggingOptions,
    pub error_response_preview_limit: usize,
    pub user_agent: Option<String>,
    pub max_redirects: Option<usize>,
    pub pool_idle_timeout: Option<Duration>,
    pub pool_max_idle_per_host: Option<usize>,
    pub use_env_proxy: bool,
    pub retry: HttpRetryOptions,
    pub sensitive_headers: SensitiveHttpHeaders,
    pub ipv4_only: bool,
    pub sse_json_mode: SseJsonMode,
    pub sse_done_marker_policy: DoneMarkerPolicy,
    pub sse_max_line_bytes: usize,
    pub sse_max_frame_bytes: usize,
}

Aggregated settings for crate::HttpClient and crate::HttpClientFactory.

Fields

base_url: Option<Url>

Optional base URL.

default_headers: HeaderMap

Default request headers.

timeouts: HttpTimeoutOptions

Timeout options.

proxy: ProxyOptions

Proxy options.

logging: HttpLoggingOptions

Logging options.

error_response_preview_limit: usize

Maximum bytes captured into HttpError.response_body_preview for non-success responses.

user_agent: Option<String>

Optional default User-Agent header sent by reqwest.

max_redirects: Option<usize>

Optional redirect limit applied by reqwest.

pool_idle_timeout: Option<Duration>

Optional connection pool idle-time timeout.

pool_max_idle_per_host: Option<usize>

Optional maximum idle connections per host.

use_env_proxy: bool

Whether to inherit proxy settings from environment variables when explicit proxy config is disabled.

retry: HttpRetryOptions

Retry options.

sensitive_headers: SensitiveHttpHeaders

Sensitive headers for masking.

ipv4_only: bool

Whether IPv4-only DNS behavior is requested.

sse_json_mode: SseJsonMode

Default JSON handling mode used by crate::HttpResponse::sse_chunks.

sse_done_marker_policy: DoneMarkerPolicy

Default done-marker policy used by crate::HttpResponse::sse_chunks.

sse_max_line_bytes: usize

Default maximum bytes for one SSE line.

sse_max_frame_bytes: usize

Default maximum bytes for one SSE frame.

Implementations

impl HttpClientOptions

pub fn new() -> Self

Same as HttpClientOptions::default.

Returns

Fresh options with crate defaults.

pub fn set_base_url( &mut self, base_url: &str, ) -> Result<&mut Self, HttpConfigError>

Parses and sets the base URL used to resolve relative request paths.

Parameters

• base_url: Absolute base URL string.

Returns

Ok(self) or HttpConfigError if the URL is invalid.

pub fn add_header(&mut self, name: &str, value: &str) -> HttpResult<&mut Self>

Validates and adds one client-level default header.

Parameters

• name: Header name.
• value: Header value.

Returns

Ok(self) or an error if name/value are invalid.

pub fn add_headers(&mut self, headers: &[(&str, &str)]) -> HttpResult<&mut Self>

Validates and adds many client-level default headers atomically.

If any input pair is invalid, no header from this batch is applied.

Parameters

• headers: Iterator of (name, value) pairs.

Returns

Ok(self) or an error if any pair is invalid.

pub fn from_config<R>(config: &R) -> Result<Self, HttpConfigError>

where R: ConfigReader + ?Sized,

Creates HttpClientOptions from config using relative keys.

Parameters

• config: Any ConfigReader (full qubit_config::Config or a qubit_config::ConfigPrefixView from ConfigReader::prefix_view).

Returns

Parsed options or HttpConfigError.

pub fn validate(&self) -> Result<(), HttpConfigError>

Runs ProxyOptions::validate, HttpLoggingOptions::validate, retry validation, and SSE limit validation.

Returns

Ok(()) or the first sub-validator error.

Trait Implementations

impl Clone for HttpClientOptions

fn clone(&self) -> HttpClientOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpClientOptions

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

Formats the value using the given formatter.

impl Default for HttpClientOptions

fn default() -> Self

Default: no base URL, empty headers, default timeouts/proxy/logging, default sensitive headers, IPv4-only off, lenient SSE JSON mode, default SSE done-marker policy, and crate default SSE line/frame limits.

Returns

Default HttpClientOptions.