Skip to main content

HttpRequestBuilder

qubit_http

Struct HttpRequestBuilder 

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

Builder for HttpRequest.

Implementations§

Source§

impl HttpRequestBuilder

Source

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

Appends a single key=value query pair (order preserved).

§Parameters
  • key: Query parameter name.
  • value: Query parameter value.
§Returns

self for chaining.

Source

pub fn query_params<'a, I>(self, params: I) -> Self
where I: IntoIterator<Item = (&'a str, &'a str)>,

Appends many query pairs via HttpRequestBuilder::query_param.

§Parameters
  • params: Iterator of (key, value) pairs.
§Returns

self for chaining.

Source

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

Validates and inserts one header.

§Parameters
§Returns

Ok(self) or HttpError if name/value are invalid.

Source

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

Merges all entries from headers into this builder (existing names may get extra values).

§Parameters
  • headers: Map to append.
§Returns

self for chaining.

Source

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

Sets the body to raw bytes without changing Content-Type unless already set elsewhere.

§Parameters
  • body: Payload.
§Returns

self for chaining.

Source

pub fn stream_body<I, B>(self, chunks: I) -> Self
where I: IntoIterator<Item = B>, B: Into<Bytes>,

Sets the body to an ordered chunk stream for incremental upload.

§Parameters
  • chunks: Iterator of chunks in send order.
§Returns

self for chaining.

Source

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

Sets a UTF-8 text body and adds text/plain; charset=utf-8 if Content-Type is absent.

§Parameters
  • body: Text payload.
§Returns

self for chaining.

Source

pub fn json_body<T>(self, value: &T) -> HttpResult<Self>
where T: Serialize,

Serializes value to JSON, sets body to those bytes, and adds application/json if needed.

§Parameters
  • value: Serializable value.
§Returns

Ok(self) or HttpError if JSON encoding fails.

Source

pub fn form_body<'a, I>(self, fields: I) -> Self
where I: IntoIterator<Item = (&'a str, &'a str)>,

Serializes key-value pairs as application/x-www-form-urlencoded.

§Parameters
  • fields: Iterable of (key, value) string pairs.
§Returns

self for chaining.

Source

pub fn multipart_body( self, body: impl Into<Bytes>, boundary: &str, ) -> HttpResult<Self>

Sets multipart body bytes and optional auto content-type by boundary.

§Parameters
  • body: Multipart payload bytes.
  • boundary: Multipart boundary used in payload framing.
§Returns

Ok(self) for chaining.

§Errors

Returns HttpError when boundary is empty or content-type cannot be built.

Source

pub fn ndjson_body<T>(self, records: &[T]) -> HttpResult<Self>
where T: Serialize,

Serializes records as NDJSON (one JSON object per line).

§Parameters
  • records: Serializable records to encode as NDJSON lines.
§Returns

Ok(self) for chaining.

§Errors

Returns HttpError when any record fails JSON serialization.

Source

pub fn timeout(self, timeout: Duration) -> Self

Overrides the client-wide request timeout for this request only.

§Parameters
  • timeout: Maximum time for the whole request (reqwest timeout).
§Returns

self for chaining.

Source

pub fn write_timeout(self, timeout: Duration) -> Self

Overrides the write-phase timeout for this request only.

§Parameters
  • timeout: Maximum time allowed for sending the request bytes.
§Returns

self for chaining.

Source

pub fn read_timeout(self, timeout: Duration) -> Self

Overrides the read-phase timeout for this request only.

§Parameters
  • timeout: Maximum time allowed for one read wait on response body.
§Returns

self for chaining.

Source

pub fn base_url(self, base_url: Url) -> Self

Overrides the client default base URL for this request.

§Parameters
  • base_url: Base URL used when resolving relative request paths.
§Returns

self for chaining.

Source

pub fn clear_base_url(self) -> Self

Clears the base URL for this request.

§Returns

self for chaining.

Source

pub fn ipv4_only(self, enabled: bool) -> Self

Overrides whether this request enforces IPv4-only literal-host validation.

§Parameters
  • enabled: true to reject IPv6 literal hosts, false to allow them.
§Returns

self for chaining.

Source

pub fn cancellation_token(self, token: CancellationToken) -> Self

Binds a CancellationToken to this request.

§Parameters
  • token: Cancellation token checked before send and during request/stream I/O.
§Returns

self for chaining.

Source

pub fn force_retry(self) -> Self

Forces retry enabled for this request even if client-level retry is disabled.

§Returns

self for chaining.

Source

pub fn disable_retry(self) -> Self

Disables retry for this request even if client-level retry is enabled.

§Returns

self for chaining.

Source

pub fn retry_method_policy(self, policy: HttpRetryMethodPolicy) -> Self

Overrides retryable-method policy for this request.

§Parameters
  • policy: Method policy to apply on this request only.
§Returns

self for chaining.

Source

pub fn honor_retry_after(self, enabled: bool) -> Self

Enables or disables honoring Retry-After for this request.

§Parameters
  • enabled: true to honor Retry-After on retryable status responses (429 and 5xx).
§Returns

self for chaining.

Source

pub fn build(self) -> HttpRequest

Consumes the builder into a frozen HttpRequest.

§Returns

Built HttpRequest.

Trait Implementations§

Source§

impl Clone for HttpRequestBuilder

Source§

fn clone(&self) -> HttpRequestBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HttpRequestBuilder

Source§

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

Formats the value using the given formatter. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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