Skip to main content

NativeRequestBuilder

Struct NativeRequestBuilder 

Source
pub struct NativeRequestBuilder { /* private fields */ }
Expand description

Builder for a native request addressed by an [http::Uri.

Create one with crate::Client::get_uri or crate::Client::request_uri. The builder is dispatched through the native transport, so it applies none of the high-level request policy: no redirect following, no logical retries, no cookie jar, no authentication, no response decompression, and no decoded-body limits.

The request is sent exactly once. Self::without_retry and Self::redirect_policy therefore cannot change the wire behavior; they exist so the same request-building code can express a single-attempt contract in every profile.

Implementations§

Source§

impl NativeRequestBuilder

Source

pub fn header(self, name: &str, value: &str) -> Self

Add a single header to the request.

An invalid header name or value is recorded and reported by Self::build and Self::send.

Source

pub fn headers(self, headers: Headers) -> Self

Replace all headers with the provided set.

Source

pub fn body(self, body: impl Into<RequestBody>) -> Self

Set the request body from any type that converts into RequestBody.

Source

pub fn bytes(self, data: impl Into<Bytes>) -> Self

Set the request body from bytes.

Source

pub fn version(self, version: Version) -> Self

Set the HTTP version for this request.

The default is HTTP/1.1. HTTP/2 is selected by protocol negotiation unless the client is built with an explicit version policy.

Source

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.

Source

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, resolved destination) without affecting logical URL semantics.

Source

pub fn without_retry(self) -> Self

Assert that this request must not be retried.

The native transport dispatches exactly once, so this call cannot change the wire behavior: the assertion already holds. It exists so a request built for the high-level API can express the same single-attempt contract in a profile that compiles out the retry engine.

Source

pub fn redirect_policy(self, policy: RedirectPolicy) -> Self

Attach a redirect policy to this request.

The native transport never follows redirects, so this call cannot change the wire behavior: a 3xx response is returned unchanged. It exists so a request built for the high-level API can express the same “do not follow redirects” contract in a profile that compiles out the redirect loop.

Source

pub fn build(self) -> Result<Request<RequestBody>>

Build the request without sending it.

§Errors

Returns an error if a previous builder step failed (for example an invalid header).

Source

pub async fn send(self) -> Result<Response<NativeResponseBody>>

Build and send the request.

The response is an ordinary http::Response whose body is a NativeResponseBody. The logical pool lease is held by the response body until it reaches EOF, errors, or is dropped.

§Errors

Returns an error if the request could not be built or sent.

Trait Implementations§

Source§

impl Debug for NativeRequestBuilder

Source§

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

Render the builder without the query string.

A native URI is caller-owned and may carry query material (API keys routinely travel in query parameters), so only the scheme, authority, and path are shown.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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<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