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 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.

impl HttpClient

pub fn py_new( default_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>, ) -> PyResult<Self>

Creates a new HttpClient.

Rate limiting can be configured on a per-endpoint basis by passing key-value pairs of endpoint URLs and their respective quotas.

For /foo -> 10 reqs/sec configure limit with (“foo”, Quota.rate_per_second(10))

Hierarchical rate limiting can be achieved by configuring the quotas for each level.

For /foo/bar -> 10 reqs/sec and /foo -> 20 reqs/sec configure limits for keys “foo/bar” and “foo” respectively.

When a request is made the URL should be split into all the keys within it.

For request /foo/bar, should pass keys [“foo/bar”, “foo”] for rate limiting.

Errors

• Returns HttpInvalidProxyError if the proxy URL is malformed.
• Returns HttpClientBuildError if building the HTTP client fails.

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.

impl<'py> IntoPyObject<'py> for HttpClient

type Target = HttpClient

The Python output type

type Output = Bound<'py, <HttpClient as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for HttpClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for HttpClient

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// 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.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<HttpClient>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for HttpClient

const TEXT_SIGNATURE: &'static str = "(default_headers=..., header_keys=..., keyed_quotas=..., default_quota=None, timeout_secs=None, proxy_url=None)"

impl PyMethods<HttpClient> for PyClassImplCollector<HttpClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for HttpClient

const NAME: &'static str = "HttpClient"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for HttpClient

impl ExtractPyClassWithClone for HttpClient