pub struct RequestBuilder { /* private fields */ }Expand description
Fluent builder for constructing requests.
Implementations§
Source§impl RequestBuilder
impl RequestBuilder
Sourcepub fn body(self, body: impl Into<RequestBody>) -> Self
pub fn body(self, body: impl Into<RequestBody>) -> Self
Set the request body from any type that converts into RequestBody.
Sourcepub fn timeout(self, timeout: Timeout) -> Self
pub fn timeout(self, timeout: Timeout) -> Self
Set the timeout for this specific request.
When set, this overrides the client-level timeout on a per-field basis: only fields present here replace the corresponding client-level fields.
Sourcepub fn redirect_policy(self, policy: RedirectPolicy) -> Self
pub fn redirect_policy(self, policy: RedirectPolicy) -> Self
Override the redirect policy for this specific request.
Only available with the redirects feature. When set, this overrides
the client-level redirect policy for this request only.
Sourcepub fn auth(self, auth: impl Into<AuthScheme>) -> Self
pub fn auth(self, auth: impl Into<AuthScheme>) -> Self
Set authentication for this specific request.
Overrides client-level auth.
Sourcepub fn without_auth(self) -> Self
pub fn without_auth(self) -> Self
Disable authentication for this specific request.
When set, no auth is applied to this request even if the client has a default auth configured.
Sourcepub fn decompress(self, decompress: bool) -> Self
pub fn decompress(self, decompress: bool) -> Self
Override decompression for this specific request.
true: enable decompression regardless of client settingfalse: disable decompression regardless of client setting
Sourcepub fn max_decoded_body_size(self, max: usize) -> Self
pub fn max_decoded_body_size(self, max: usize) -> Self
Override the client decoded response body size limit for this request.
The request setting takes precedence over the client setting and is
carried across retries and redirects. It applies to decoded compressed
data and ordinary unencoded/identity response bodies, whether the
response is buffered or streamed. A value of zero rejects any
non-empty decoded response body and yields
crate::Error::DecodedBodyTooLarge.
Sourcepub fn max_decompression_ratio(self, ratio: f64) -> Self
pub fn max_decompression_ratio(self, ratio: f64) -> Self
Override the client decompression ratio limit for this request.
The request setting takes precedence over the client setting and is carried across retries and redirects.
§Panics
Panics if ratio is not finite or not positive.
Sourcepub fn retry(self, policy: RetryPolicy) -> Self
pub fn retry(self, policy: RetryPolicy) -> Self
Override the retry policy for this specific request.
Only available with the logical-retry feature. When set, this
overrides the client-level retry policy for this request only.
Sourcepub fn without_retry(self) -> Self
pub fn without_retry(self) -> Self
Disable retries for this specific request, even if the client has a retry policy configured.
Only available with the logical-retry feature.
Sourcepub fn transport_hints(self, hints: TransportHints) -> Self
pub fn transport_hints(self, hints: TransportHints) -> Self
Set the transport hints for this request.
Transport hints control wire-level behavior (target override, SNI hostname) without affecting logical URL semantics.
Sourcepub fn resolved_addresses<I>(self, addresses: I) -> Selfwhere
I: IntoIterator<Item = SocketAddr>,
pub fn resolved_addresses<I>(self, addresses: I) -> Selfwhere
I: IntoIterator<Item = SocketAddr>,
Pin this request to caller-supplied remote destinations.
The logical URL remains unchanged for HTTP authority, TLS identity, redirects, cookies, and authentication. The set must be non-empty and each address must use the URL’s effective HTTP/HTTPS port. Static routing is direct-only; proxy and HTTP/3 combinations fail closed.
Only available with the advanced-routing feature (enabled by the
native-http1/native-http2 compatibility slices). The lean
standard-route profile omits pinned routing and fails closed if a
resolved destination is supplied via transport hints.
Sourcepub fn proxy_target_addresses<I>(self, addresses: I) -> Selfwhere
I: IntoIterator<Item = SocketAddr>,
pub fn proxy_target_addresses<I>(self, addresses: I) -> Selfwhere
I: IntoIterator<Item = SocketAddr>,
Pin a proxied request to caller-supplied physical destinations.
This is distinct from Self::resolved_addresses, which remains a
direct-only route. The logical URL remains authoritative for proxy
selection, HTTP Host, TLS SNI/certificate verification, redirects,
cookies, and authentication. HTTP CONNECT and local-resolution
SOCKS5 use these addresses without an origin DNS lookup. SOCKS5H and
plaintext HTTP forward-proxy requests reject this option.
Sourcepub fn build(self) -> Result<Request>
pub fn build(self) -> Result<Request>
Build the request without sending it.
§Errors
Returns an error if a previous builder step failed (e.g., invalid header).
Sourcepub async fn send_detailed(self) -> Result<Response, RequestFailure>
pub async fn send_detailed(self) -> Result<Response, RequestFailure>
Build and send the request with optional structured native failure classification.
The underlying crate::Error and all ordinary request behavior are
unchanged. Use RequestFailure::into_error
to recover the legacy error without loss.
§Errors
Returns the original error wrapped in crate::RequestFailure if the
request could not be built or sent.