Struct HttpClient

pub struct HttpClient { /* private fields */ }

A high-performance HTTP client with rate limiting and timeout capabilities.

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 py_new( header_keys: Vec<String>, keyed_quotas: Vec<(String, Quota)>, default_quota: Option<Quota>, ) -> Self

Create a new HttpClient.

header_keys: The key value pairs for the given header_keys are retained from the responses. keyed_quota: A list of string quota pairs that gives quota for specific key values. default_quota: The default rate limiting quota for any request. Default quota is optional and no quota is passthrough.

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.

Trait Implementations

impl HasPyGilRef for HttpClient

type AsRefTarget = PyCell<HttpClient>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for HttpClient

fn into_py(self, py: Python<'_>) -> PyObject

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)]

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<HttpClient> for PyClassImplCollector<HttpClient>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a HttpClient

type Holder = Option<PyRef<'py, HttpClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut HttpClient

type Holder = Option<PyRefMut<'py, HttpClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

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<'_>) -> &PyType

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

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

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

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

fn is_type_of_bound(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: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

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

Checks if object is an instance of this type.

impl DerefToPyAny for HttpClient