Struct RequestBuilder 

pub struct RequestBuilder<'a> { /* private fields */ }

Available on crate features async-tls-native or async-tls-rustls-aws-lc-rs or async-tls-rustls-ring only.

Builds and executes a single request against an existing Client.

Create a builder from Client::request or the verb helpers such as Client::get and Client::post.

See also:

• examples/request_helpers.rs
• examples/request_overrides.rs
• examples/streaming.rs

Example

use reqx::prelude::Client;

let client = Client::builder("https://api.example.com").build()?;
let response = client
    .post("/v1/items")
    .idempotency_key("item-1")?
    .query_pair("verbose", "true")
    .json(&serde_json::json!({ "name": "demo" }))?
    .send_response()
    .await?;

let _status = response.status();

Implementations

impl<'a> RequestBuilder<'a>

pub fn header(self, name: HeaderName, value: HeaderValue) -> Self

Available on crate feature _async only.

Adds a header to this request.

See also examples/request_helpers.rs.

pub fn try_header(self, name: &str, value: &str) -> Result<Self>

Available on crate feature _async only.

Parses and adds a header to this request.

pub fn idempotency_key(self, key: &str) -> Result<Self>

Available on crate feature _async only.

Sets the Idempotency-Key header for retry-safe mutations.

pub fn query_pair( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Available on crate feature _async only.

Appends one query parameter pair.

pub fn query_pairs<K, V, I>(self, pairs: I) -> Self

where K: Into<String>, V: Into<String>, I: IntoIterator<Item = (K, V)>,

Available on crate feature _async only.

Appends multiple query parameter pairs.

pub fn query<T>(self, params: &T) -> Result<Self>

where T: Serialize + ?Sized,

Available on crate feature _async only.

Serializes and appends query parameters from params.

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

Available on crate feature _async only.

Sets a fully buffered request body.

pub fn body_stream<S, E>(self, stream: S) -> Self

where S: Stream<Item = Result<Bytes, E>> + Send + 'static, E: StdError + Send + Sync + 'static,

Available on crate feature _async only.

Sets a streaming request body.

pub fn body_reader<R>(self, reader: R) -> Self

where R: AsyncRead + Send + 'static,

Available on crate feature _async only.

Streams an async reader as the request body.

See also examples/streaming.rs.

pub fn body_reader_with_length<R>( self, reader: R, content_length: u64, ) -> Result<Self>

where R: AsyncRead + Send + 'static,

Available on crate feature _async only.

Streams an async reader as the request body and sets Content-Length.

pub fn json<T>(self, payload: &T) -> Result<Self>

where T: Serialize + ?Sized,

Available on crate feature _async only.

Serializes payload as JSON and sets Content-Type: application/json.

See also examples/basic_json.rs.

pub fn form<T>(self, payload: &T) -> Result<Self>

where T: Serialize + ?Sized,

Available on crate feature _async only.

Serializes payload as form data and sets the form content type.

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

Available on crate feature _async only.

Overrides the per-attempt request timeout for this request.

A zero duration is rejected by send or send_stream.

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

Available on crate feature _async only.

Overrides the overall deadline for this request.

A zero duration is rejected by send or send_stream.

pub fn max_response_body_bytes(self, max_response_body_bytes: usize) -> Self

Available on crate feature _async only.

Overrides the buffered response body size limit for this request.

pub fn retry_policy(self, retry_policy: RetryPolicy) -> Self

Available on crate feature _async only.

Overrides the retry policy for this request.

See also examples/request_overrides.rs.

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

Available on crate feature _async only.

Overrides redirect handling for this request.

pub fn status_policy(self, status_policy: StatusPolicy) -> Self

Available on crate feature _async only.

Overrides status handling for this request.

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

Available on crate feature _async only.

Overrides automatic Accept-Encoding injection for this request.

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

Available on crate feature _async only.

Executes the request and applies the effective StatusPolicy.

pub async fn send_stream(self) -> Result<ResponseStream>

Available on crate feature _async only.

Executes the request and returns a streaming response body.

Non-success HTTP statuses still follow the effective StatusPolicy. See also examples/streaming.rs.

pub async fn download_to_writer<W>(self, writer: &mut W) -> Result<u64>

where W: AsyncWrite + Unpin + Send + ?Sized,

Available on crate feature _async only.

Streams the response body into writer.

See also examples/streaming.rs.

pub async fn download_to_writer_limited<W>( self, writer: &mut W, max_bytes: usize, ) -> Result<u64>

where W: AsyncWrite + Unpin + Send + ?Sized,

Available on crate feature _async only.

Streams the response body into writer, enforcing max_bytes.

See also examples/streaming.rs.

pub async fn send_json<T>(self) -> Result<T>

where T: DeserializeOwned,

Available on crate feature _async only.

Executes the request, buffers the body, and deserializes it as JSON.

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

Available on crate feature _async only.

Executes the request and always returns a buffered crate::Response for HTTP status responses.

pub async fn send_response_stream(self) -> Result<ResponseStream>

Available on crate feature _async only.

Executes the request and always returns a streaming response for HTTP status responses.