pub struct HttpClientOptions {
pub base_url: Option<Url>,
pub default_headers: HeaderMap,
pub timeouts: TimeoutOptions,
pub proxy: ProxyOptions,
pub logging: HttpLoggingOptions,
pub retry: HttpRetryOptions,
pub sensitive_headers: SensitiveHeaders,
pub ipv4_only: bool,
pub sse_json_mode: SseJsonMode,
pub sse_max_line_bytes: usize,
pub sse_max_frame_bytes: usize,
}Expand description
Aggregated settings for crate::HttpClient and crate::HttpClientFactory.
Fields§
§base_url: Option<Url>Optional base URL.
default_headers: HeaderMapDefault request headers.
timeouts: TimeoutOptionsTimeout options.
proxy: ProxyOptionsProxy options.
logging: HttpLoggingOptionsLogging options.
retry: HttpRetryOptionsRetry options.
sensitive_headers: SensitiveHeadersSensitive headers for masking.
ipv4_only: boolWhether IPv4-only DNS behavior is requested.
sse_json_mode: SseJsonModeDefault JSON handling mode used by crate::HttpStreamResponse::decode_json_chunks.
sse_max_line_bytes: usizeDefault maximum bytes for one SSE line.
sse_max_frame_bytes: usizeDefault maximum bytes for one SSE frame.
Implementations§
Source§impl HttpClientOptions
impl HttpClientOptions
Sourcepub fn set_base_url(
&mut self,
base_url: &str,
) -> Result<&mut Self, HttpConfigError>
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.
Sourcepub fn add_header(&mut self, name: &str, value: &str) -> HttpResult<&mut Self>
pub fn add_header(&mut self, name: &str, value: &str) -> HttpResult<&mut Self>
Sourcepub fn add_headers<'a, I>(&mut self, headers: I) -> HttpResult<&mut Self>
pub fn add_headers<'a, I>(&mut self, headers: I) -> HttpResult<&mut Self>
Sourcepub fn from_config<R>(config: &R) -> Result<Self, HttpConfigError>where
R: ConfigReader + ?Sized,
pub fn from_config<R>(config: &R) -> Result<Self, HttpConfigError>where
R: ConfigReader + ?Sized,
Creates HttpClientOptions from config using relative keys.
§Parameters
config: AnyConfigReader(fullqubit_config::Configor aqubit_config::ConfigPrefixViewfromConfigReader::prefix_view).
§Returns
Parsed options or HttpConfigError.
Sourcepub fn validate(&self) -> Result<(), 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§
Source§impl Clone for HttpClientOptions
impl Clone for HttpClientOptions
Source§fn clone(&self) -> HttpClientOptions
fn clone(&self) -> HttpClientOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for HttpClientOptions
impl Debug for HttpClientOptions
Source§impl Default for HttpClientOptions
impl Default for HttpClientOptions
Source§fn default() -> Self
fn default() -> Self
Default: no base URL, empty headers, default timeouts/proxy/logging, default sensitive headers, IPv4-only off, lenient SSE JSON mode with crate default SSE line/frame limits.
§Returns
Default HttpClientOptions.