Struct RequestBuilder 

pub struct RequestBuilder<C = HttpConnector> { /* private fields */ }

Builder for a single HTTP request.

Created via Client::get(), Client::post(), etc.

Implementations

impl<C> RequestBuilder<C>

where C: Connect + Clone + Send + Sync + 'static,

pub fn header(self, key: &str, value: &str) -> Result<Self, OxiHttpError>

Add a request header.

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

Add multiple headers from a HeaderMap.

pub fn bearer_token(self, token: &str) -> Result<Self, OxiHttpError>

Set a Bearer token for the Authorization header.

pub fn basic_auth( self, username: &str, password: Option<&str>, ) -> Result<Self, OxiHttpError>

Set Basic authentication for the Authorization header.

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

Set the request body as raw bytes.

pub fn json<T: Serialize>(self, value: &T) -> Result<Self, OxiHttpError>

Set the request body as JSON, automatically setting the Content-Type header.

pub fn form(self, form_body: &FormBody) -> Self

Set the request body as URL-encoded form data.

pub fn multipart(self, builder: MultipartBuilder) -> Self

Set the request body from a MultipartBuilder, automatically setting the Content-Type: multipart/form-data; boundary=… header.

The Content-Type is only set if the caller has not already provided one. This allows overriding the header with an explicit .header() call made before .multipart().

Example

use oxihttp_client::Client;
use oxihttp_core::MultipartBuilder;

let client = Client::builder().build()?;
let builder = MultipartBuilder::new().add_text("field", "value");
let resp = client.post("http://example.com/upload")?
    .multipart(builder)
    .send()
    .await?;

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

Set a per-request timeout.

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

Send the request and return the response.

Respects retry policy and per-request timeout. Before the first attempt the before_request hook is called on each registered middleware; after a successful response after_response is called with the final status and elapsed wall-clock time.