Struct HttpClient 

pub struct HttpClient { /* private fields */ }

High-level HTTP client: default headers, injectors, interceptors, logging, timeouts, and optional per-request retry.

Clone is shallow and cheap enough for typical use (including passing into retry closures); cloning does not duplicate the underlying connection pool beyond what reqwest::Client already shares.

Implementations

impl HttpClient

pub fn options(&self) -> &HttpClientOptions

Returns a reference to the client-wide options (timeouts, proxy, logging, default headers, retry defaults, etc.).

Returns

Immutable borrow of HttpClientOptions. Never None; always the options installed on this client.

pub fn add_header_injector(&mut self, injector: HttpHeaderInjector)

Appends a HttpHeaderInjector so its mutation function runs on every request. Mutates self in place.

Parameters

• injector: Injector to append (order is preserved).

pub fn add_async_header_injector(&mut self, injector: AsyncHttpHeaderInjector)

Appends an async header injector whose mutation runs after sync injectors. Mutates self in place.

Parameters

• injector: Async injector to append (order is preserved).

pub fn add_request_interceptor(&mut self, interceptor: HttpRequestInterceptor)

Appends a request interceptor run before each send attempt (including each retry attempt). Mutates self in place.

Parameters

• interceptor: Request interceptor to append (order is preserved).

pub fn add_response_interceptor(&mut self, interceptor: HttpResponseInterceptor)

Appends a response interceptor run only after a successful HTTP status (after the internal execute_once step) and before response body logging. Mutates self in place.

Parameters

• interceptor: Response interceptor to append (order is preserved).

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

Validates and adds one client-level default header.

The header is applied to every request before header injectors and request-level headers.

Parameters

• name: Header name.
• value: Header value.

Returns

Ok(self) after the header is stored.

Errors

Returns HttpError when the header name or value is invalid.

pub fn add_headers(&mut self, headers: &[(&str, &str)]) -> HttpResult<&mut Self>

Validates and adds many client-level default headers atomically.

If any input pair is invalid, no header from this batch is applied.

Parameters

• headers: Iterator of (name, value) pairs.

Returns

Ok(self) after all headers are stored.

Errors

Returns HttpError when any name/value pair is invalid (nothing from this call is applied).

pub fn clear_header_injectors(&mut self)

Clears all synchronous header injectors. Mutates self in place.

pub fn clear_async_header_injectors(&mut self)

Clears all async header injectors. Mutates self in place.

pub fn clear_request_interceptors(&mut self)

Clears all request interceptors. Mutates self in place.

pub fn clear_response_interceptors(&mut self)

Clears all response interceptors. Mutates self in place.

pub fn request(&self, method: Method, path: &str) -> HttpRequestBuilder

Starts building an HttpRequest with the given method and path (relative or absolute URL string).

Parameters

• method: HTTP verb (GET, POST, …).
• path: Path relative to HttpClientOptions::base_url or a full URL string.

Returns

A new HttpRequestBuilder borrowing this client for defaults; it is not sent until built and passed to HttpClient::execute (or related APIs).

pub async fn execute(&self, request: HttpRequest) -> HttpResult<HttpResponse>

Sends the request and returns a unified HttpResponse.

Chooses retry vs single attempt from resolved HttpRetryOptions for this request. Performs network I/O and may await the internal execute_once path multiple times with backoff between attempts when retry is enabled.

Parameters

• request: Built request (URL resolved against base_url if path is not absolute).

Returns

• Ok(HttpResponse) when the HTTP status is success (http::StatusCode::is_success).
• Err(HttpError) when any attempt fails for URL/header validation, cancellation, interceptor failure, transport/timeout, non-success status, or when the retry executor aborts or exceeds limits.

pub fn execute_sse_with_reconnect( &self, request: HttpRequest, options: SseReconnectOptions, ) -> SseEventStream

Opens an SSE stream and reconnects automatically on retryable stream failures.

Reconnect behavior:

• retryable transport/read failures trigger reconnects;
• optional reconnect on clean EOF (reconnect_on_eof);
• Last-Event-ID is set from the latest parsed SSE id: field;
• optional use of SSE retry: as next reconnect delay.

Parameters

• request: SSE request template reused on reconnect.
• options: Reconnect limits and delay policy.

Returns

SSE event stream yielding events from one or more reconnect sessions.

Errors

Stream items are Result; Err covers per-item failures such as:

• initial stream-open failures when not reconnectable or retries exhausted;
• SSE protocol errors (non-reconnectable by default);
• transport/read errors after reconnect budget is exhausted.

Side effects

Performs repeated HTTP requests and reads on reconnect; may sleep between attempts according to reconnect options.

Trait Implementations

impl Clone for HttpClient

fn clone(&self) -> HttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpClient

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

Formats the client for debugging (exposes options and injectors; omits the backend client).

Parameters

• f: Destination formatter.

Returns

fmt::Result from writing the debug struct.

Errors

Returns an error if formatting to f fails.