Skip to main content

RequestBuilder

Struct RequestBuilder 

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

Fluent builder for constructing requests.

Implementations§

Source§

impl RequestBuilder

Source

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

Add a single header to the request.

Source

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

Replace all headers with the provided set.

Source

pub fn query(self, key: &str, value: &str) -> Self

Append a query parameter to the URL.

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 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 redirect_policy(self, policy: RedirectPolicy) -> Self

Override the redirect policy for this specific request.

When set, this overrides the client-level redirect policy for this request only.

Source

pub fn auth(self, auth: impl Into<AuthScheme>) -> Self

Set authentication for this specific request.

Overrides client-level auth.

Source

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.

Source

pub fn decompress(self, decompress: bool) -> Self

Override decompression for this specific request.

  • true: enable decompression regardless of client setting
  • false: disable decompression regardless of client setting
Source

pub fn retry(self, policy: RetryPolicy) -> Self

Override the retry policy for this specific request.

When set, this overrides the client-level retry policy for this request only.

Source

pub fn without_retry(self) -> Self

Disable retries for this specific request, even if the client has a retry policy configured.

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

Source

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).

Source

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

Build and send the request.

§Errors

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

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