Skip to main content

HttpClient

Struct HttpClient 

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

HTTP client with tower middleware stack

This client provides a clean interface over a tower service stack that includes:

  • Timeout handling
  • Automatic retries with exponential backoff
  • User-Agent header injection
  • Concurrency limiting (optional)

Use HttpClientBuilder to construct instances with custom configuration.

§Thread Safety

HttpClient is Clone + Send + Sync. Cloning is cheap (internal channel clone). The client uses tower::buffer::Buffer internally, which allows true concurrent access without any mutex serialization. Callers do NOT need to wrap HttpClient in Mutex or Arc<Mutex<_>>.

§Example

// Just store the client directly - no Mutex needed!
struct MyService {
    http: HttpClient,
}

impl MyService {
    async fn fetch(&self) -> Result<Data, HttpError> {
        // reqwest-like API: response has body-reading methods
        self.http.get("https://example.com/api").await?.json().await
    }
}

Implementations§

Source§

impl HttpClient

Source

pub fn new() -> Result<Self, HttpError>

Create a new HTTP client with default configuration

§Errors

Returns an error if TLS initialization fails

Source

pub fn builder() -> HttpClientBuilder

Create a builder for configuring the HTTP client

Source

pub fn get(&self, url: &str) -> RequestBuilder

Create a GET request builder

Returns a RequestBuilder that can be configured with headers before sending with .send().await.

§URL Requirements

The URL must be an absolute URI with scheme and authority (host). Relative URLs like /path or example.com/path are rejected with HttpError::InvalidUri.

Valid examples:

§URL Construction

Query parameters must be encoded into the URL externally (e.g. via url::Url):

use url::Url;

let mut url = Url::parse("https://api.example.com/search")?;
url.query_pairs_mut().append_pair("q", "rust").append_pair("page", "1");

let resp = client
    .get(url.as_str())
    .header("authorization", "Bearer token")
    .send()
    .await?;
§Example
// Simple GET
let resp = client.get("https://api.example.com/data").send().await?;
Source

pub fn post(&self, url: &str) -> RequestBuilder

Create a POST request builder

Returns a RequestBuilder that can be configured with headers, body (JSON, form, bytes), etc. before sending with .send().await.

§Example
// POST with JSON body
let resp = client
    .post("https://api.example.com/users")
    .json(&NewUser { name: "Alice" })?
    .send()
    .await?;

// POST with form body
let resp = client
    .post("https://auth.example.com/token")
    .form(&[("grant_type", "client_credentials")])?
    .send()
    .await?;
Source

pub fn put(&self, url: &str) -> RequestBuilder

Create a PUT request builder

Returns a RequestBuilder that can be configured with headers, body (JSON, form, bytes), etc. before sending with .send().await.

§Example
let resp = client
    .put("https://api.example.com/resource/1")
    .json(&UpdateData { value: 42 })?
    .send()
    .await?;
Source

pub fn patch(&self, url: &str) -> RequestBuilder

Create a PATCH request builder

Returns a RequestBuilder that can be configured with headers, body (JSON, form, bytes), etc. before sending with .send().await.

§Example
let resp = client
    .patch("https://api.example.com/resource/1")
    .json(&PatchData { field: "new_value" })?
    .send()
    .await?;
Source

pub fn delete(&self, url: &str) -> RequestBuilder

Create a DELETE request builder

Returns a RequestBuilder that can be configured with headers before sending with .send().await.

§Example
let resp = client
    .delete("https://api.example.com/resource/42")
    .header("authorization", "Bearer token")
    .send()
    .await?;

Trait Implementations§

Source§

impl Clone for HttpClient

Source§

fn clone(&self) -> HttpClient

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

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> ServiceExt for T

Source§

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more
Source§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
Source§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
Source§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

fn set_request_id<M>( self, header_name: HeaderName, make_request_id: M, ) -> SetRequestId<Self, M>
where Self: Sized, M: MakeRequestId,

Add request id header and extension. Read more
Source§

fn set_x_request_id<M>(self, make_request_id: M) -> SetRequestId<Self, M>
where Self: Sized, M: MakeRequestId,

Add request id header and extension, using x-request-id as the header name. Read more
Source§

fn propagate_request_id( self, header_name: HeaderName, ) -> PropagateRequestId<Self>
where Self: Sized,

Propgate request ids from requests to responses. Read more
Source§

fn propagate_x_request_id(self) -> PropagateRequestId<Self>
where Self: Sized,

Propgate request ids from requests to responses, using x-request-id as the header name. Read more
Source§

fn request_body_limit(self, limit: usize) -> RequestBodyLimit<Self>
where Self: Sized,

Intercept requests with over-sized payloads and convert them into 413 Payload Too Large responses. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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