Struct HttpClient 

pub struct HttpClient { /* private fields */ }

An HTTP client that supports rate limiting and timeouts.

Built on reqwest for async I/O. Allows per-endpoint and default quotas through a rate limiter.

This struct is designed to handle HTTP requests efficiently, providing support for rate limiting, timeouts, and custom headers. The client is built on top of reqwest and can be used for both synchronous and asynchronous HTTP requests.

Implementations

impl HttpClient

pub fn new( headers: HashMap<String, String>, header_keys: Vec<String>, keyed_quotas: Vec<(String, Quota)>, default_quota: Option<Quota>, timeout_secs: Option<u64>, proxy_url: Option<String>, ) -> Result<Self, HttpClientError>

Creates a new HttpClient instance.

Errors

• Returns InvalidProxy if the proxy URL is malformed.
• Returns ClientBuildError if building the underlying reqwest::Client fails.

pub fn new_with_rate_limiter( headers: HashMap<String, String>, header_keys: Vec<String>, timeout_secs: Option<u64>, proxy_url: Option<String>, rate_limiter: Arc<RateLimiter<Ustr, MonotonicClock>>, ) -> Result<Self, HttpClientError>

Creates a new HttpClient instance sharing an externally-owned rate limiter.

Use this constructor to share a single RateLimiter across multiple HttpClient instances (for example, the HTTP clients owned by an exchange adapter’s data and execution clients). All quota state lives inside the limiter, so passing the same Arc produces a single shared bucket.

Errors

• Returns InvalidProxy if the proxy URL is malformed.
• Returns ClientBuildError if building the underlying reqwest::Client fails.

pub async fn request( &self, method: Method, url: String, params: Option<&HashMap<String, Vec<String>>>, headers: Option<HashMap<String, String>>, body: Option<Vec<u8>>, timeout_secs: Option<u64>, keys: Option<Vec<String>>, ) -> Result<HttpResponse, HttpClientError>

Sends an HTTP request.

Errors

Returns an error if unable to send request or times out.

Examples

If requesting /foo/bar, pass rate-limit keys ["foo/bar", "foo"].

pub async fn request_with_params<P: Serialize>( &self, method: Method, url: String, params: Option<&P>, headers: Option<HashMap<String, String>>, body: Option<Vec<u8>>, timeout_secs: Option<u64>, keys: Option<Vec<String>>, ) -> Result<HttpResponse, HttpClientError>

Sends an HTTP request with serializable query parameters.

This method accepts any type implementing Serialize for query parameters, which will be automatically encoded into the URL query string using reqwest’s .query() method, avoiding unnecessary HashMap allocations.

Errors

Returns an error if unable to send request or times out.

pub async fn request_with_ustr_keys( &self, method: Method, url: String, params: Option<&HashMap<String, Vec<String>>>, headers: Option<HashMap<String, String>>, body: Option<Vec<u8>>, timeout_secs: Option<u64>, keys: Option<Vec<Ustr>>, ) -> Result<HttpResponse, HttpClientError>

Sends an HTTP request using pre-interned rate limiter keys.

Errors

Returns an error if unable to send the request or the request times out.

pub async fn get( &self, url: String, params: Option<&HashMap<String, Vec<String>>>, headers: Option<HashMap<String, String>>, timeout_secs: Option<u64>, keys: Option<Vec<String>>, ) -> Result<HttpResponse, HttpClientError>

Sends an HTTP GET request.

Errors

Returns an error if unable to send request or times out.

pub async fn post( &self, url: String, params: Option<&HashMap<String, Vec<String>>>, headers: Option<HashMap<String, String>>, body: Option<Vec<u8>>, timeout_secs: Option<u64>, keys: Option<Vec<String>>, ) -> Result<HttpResponse, HttpClientError>

Sends an HTTP POST request.

Errors

Returns an error if unable to send request or times out.

pub async fn patch( &self, url: String, params: Option<&HashMap<String, Vec<String>>>, headers: Option<HashMap<String, String>>, body: Option<Vec<u8>>, timeout_secs: Option<u64>, keys: Option<Vec<String>>, ) -> Result<HttpResponse, HttpClientError>

Sends an HTTP PATCH request.

Errors

Returns an error if unable to send request or times out.

pub async fn delete( &self, url: String, params: Option<&HashMap<String, Vec<String>>>, headers: Option<HashMap<String, String>>, timeout_secs: Option<u64>, keys: Option<Vec<String>>, ) -> Result<HttpResponse, HttpClientError>

Sends an HTTP DELETE request.

Errors

Returns an error if unable to send request or times out.

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 value using the given formatter.