Skip to main content

HttpClientConfig

Struct HttpClientConfig 

Source
#[non_exhaustive]
pub struct HttpClientConfig { pub timeout_secs: u64, pub pool_max_idle_per_host: usize, pub pool_idle_timeout_secs: u64, pub user_agent: Option<String>, pub accept_invalid_certs: bool, pub proxy_url: Option<String>, pub circuit_breaker: Option<CircuitBreakerConfig>, pub max_response_bytes: usize, pub redirect: HttpRedirectPolicy, }
Expand description

HTTP 客户端配置

用于通过 HttpClient::with_config 创建自定义配置的客户端

§示例

ⓘ
use yang_base::http::{HttpClient, HttpClientConfig};

let config = HttpClientConfig {
    timeout_secs: 60,
    pool_max_idle_per_host: 10,
    user_agent: Some("MyApp/1.0".to_string()),
    ..Default::default()
};
let client = HttpClient::with_config(config)?;

Fields (Non-exhaustive)§

This struct is marked as 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.
§timeout_secs: u64

请求超时时间(秒),默认 30 秒

§pool_max_idle_per_host: usize

每个主机最大空闲连接数,默认 10

§pool_idle_timeout_secs: u64

连接池空闲超时时间(秒),默认 90 秒

§user_agent: Option<String>

自定义 User-Agent,默认为 None(使用 reqwest 默认值)

§accept_invalid_certs: bool

是否接受无效的 TLS 证书,默认 false(生产环境不应设为 true)

§proxy_url: Option<String>

代理 URL,默认为 None(不使用代理)

§circuit_breaker: Option<CircuitBreakerConfig>

熔断器策略,默认 None(不启用)。设为 Some(..) 后,对连续失败的目标 host 快速失败(返回 BaseError::HttpCircuitBreakerOpen),按 host 分键。

§max_response_bytes: usize

出站响应体最大允许字节数,默认 10 MiB(DEFAULT_MAX_RESPONSE_BYTES)。

读取响应体(bytes/json/text)时先查 Content-Length 做快速失败, 再流式累计校验运行中上限,超限返回 BaseError::HttpResponseTooLarge。

§redirect: HttpRedirectPolicy

重定向跟随策略,默认 HttpRedirectPolicy::Limited(10)(reqwest 默认: 最多跟随 10 跳)。

默认策略不逐跳校验目标 host,也不会额外剥离自定义凭证头;需要 SSRF 白名单或严格同源校验的调用方应显式设为 HttpRedirectPolicy::None, 自行校验 3xx 的 Location。

Implementations§

Source§

impl HttpClientConfig

Source

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

验证 HTTP 客户端配置。

拒绝会导致请求立即失败或连接池配置退化的零值参数。

Trait Implementations§

Source§

impl Clone for HttpClientConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HttpClientConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HttpClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more