Struct RequestBuilder 

pub struct RequestBuilder { /* private fields */ }

Fluent builder for HttpRequest.

Single-purpose, chainable. Each method returns &mut Self for fluent chaining; call RequestBuilder::build to obtain the final HttpRequest.

Examples

use http_request::{RequestBuilder, Proxy};

// sync GET
let mut req = RequestBuilder::new()
    .get("https://example.com/api")
    .header("Accept", "application/json")
    .timeout(5_000)
    .build();
let _resp = req.send();

// async POST with JSON body
let req = RequestBuilder::new()
    .post("https://example.com/api")
    .body_json(&serde_json::json!({"k": "v"}))
    .header("Content-Type", "application/json")
    .proxy(Proxy::https("127.0.0.1", 7890).auth("u", "p"))
    .build();
let _resp = req.send_async().await;

Implementations

impl RequestBuilder

pub fn get_request_mut(&mut self) -> &mut HttpRequest

Returns the underlying request mutably.

Returns

• &mut HttpRequest - The mutable request being built.

pub fn new() -> Self

Create an empty builder (defaults: GET, no headers, default config).

pub fn get<T: Into<String>>(&mut self, url: T) -> &mut Self

Shortcut for method(Method::Get) + url(url).

Arguments

• T - A value convertible into the request URL, such as &str or String.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn post<T: Into<String>>(&mut self, url: T) -> &mut Self

Shortcut for method(Method::Post) + url(url).

Arguments

• T - A value convertible into the request URL, such as &str or String.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn method(&mut self, method: Method) -> &mut Self

Set HTTP method explicitly (Method::Get / Method::Post / etc.).

Arguments

• Method - The HTTP method to apply to the request.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn url<T: Into<String>>(&mut self, url: T) -> &mut Self

Set URL.

Arguments

• T - A value convertible into the request URL, such as &str or String.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn header<K: AsRef<str>, V: AsRef<str>>( &mut self, key: K, value: V, ) -> &mut Self

Set a single header (last write wins on duplicate keys).

Arguments

• K - A header name that can be borrowed as a string slice.
• V - A header value that can be borrowed as a string slice.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn headers<K, V>(&mut self, headers: HashMap<K, V>) -> &mut Self

where K: AsRef<str>, V: AsRef<str>,

Set many headers at once.

Arguments

• HashMap<K, V> - The header name-value pairs to apply, where each name and value can be borrowed as a string slice.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn remove_header<K: AsRef<str>>(&mut self, key: K) -> &mut Self

Remove a header by key.

Arguments

• K - The header name to remove, which can be borrowed as a string slice.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn clear_headers(&mut self) -> &mut Self

Clear all headers.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn body<B: Into<Vec<u8>>>(&mut self, bytes: B) -> &mut Self

Set raw body bytes.

Arguments

• B - A value convertible into the raw body bytes, such as Vec<u8> or &[u8].

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn body_text<T: Into<String>>(&mut self, text: T) -> &mut Self

Set UTF-8 text body (will be encoded per Content-Type on send).

Arguments

• T - A value convertible into the text body, such as &str or String.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn body_json<V: Serialize>(&mut self, value: &V) -> &mut Self

Set JSON body (serialised via serde_json).

Arguments

• &V - A reference to the value to serialise as the JSON body.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn timeout(&mut self, ms: u64) -> &mut Self

Set request timeout in milliseconds.

Arguments

• u64 - The request timeout in milliseconds.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn buffer_size(&mut self, n: usize) -> &mut Self

Set per-read buffer size.

Arguments

• usize - The per-read buffer size in bytes.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn http1_1_only(&mut self) -> &mut Self

Force HTTP/1.1.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn http2_only(&mut self) -> &mut Self

Force HTTP/2.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn redirect(&mut self) -> &mut Self

Enable auto-follow of 3xx redirects.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn no_redirect(&mut self) -> &mut Self

Disable auto-follow of 3xx redirects (default).

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn max_redirect_times(&mut self, n: usize) -> &mut Self

Maximum number of redirects to follow (default DEFAULT_MAX_REDIRECT_TIMES).

Arguments

• usize - The maximum number of redirects to follow.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn decode(&mut self) -> &mut Self

Enable automatic response body decompression (gzip / deflate / br).

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn no_decode(&mut self) -> &mut Self

Disable automatic response body decompression.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn proxy(&mut self, proxy: Proxy) -> &mut Self

Set the proxy configuration. Pass None (via [Proxy::default()) to clear an existing proxy.

Construct via Proxy::http / Proxy::https / Proxy::socks5 and optionally chain .auth(user, pass).

Arguments

• Proxy - The proxy configuration to apply to the request.

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn no_proxy(&mut self) -> &mut Self

Clear the proxy (use direct connection).

Returns

• &mut Self - A mutable reference to this builder for chaining.

pub fn build(&mut self) -> HttpRequest

Finalise the builder and return the HttpRequest.

Returns

• HttpRequest - The finalised request, leaving the builder empty.

Trait Implementations

impl Clone for RequestBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestBuilder

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

Formats the value using the given formatter.

impl Default for RequestBuilder

fn default() -> Self

Returns the “default value” for a type.