Skip to main content

HttpClient

Struct HttpClient 

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

Low-level HTTP transport for the Apify API.

You usually do not interact with this directly — ApifyClient owns an HttpClient and passes references to the resource clients.

Responsibilities:

  • Base-URL + path concatenation.
  • Bearer-token authentication.
  • JSON body serialization / deserialization.
  • Translating HTTP errors into ApifyError.
  • Exponential-backoff retries for 429 Too Many Requests.

Implementations§

Source§

impl HttpClient

Source

pub fn new(token: Option<String>) -> Self

Construct a new HTTP client.

token is optional — pass None for anonymous (read-only) access.

Source

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Override the base URL used for every request.

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Re-build the underlying reqwest::Client with a custom timeout.

Source

pub async fn request<T: DeserializeOwned>( &self, method: Method, path: &str, body: Option<impl Serialize>, ) -> Result<T, ApifyError>

Send a request and deserialize the JSON body into T.

path is relative to the base URL (e.g. /actor-tasks). Authentication and JSON Content-Type are handled automatically.

Source

pub async fn request_with_retry<T: DeserializeOwned>( &self, method: Method, path: &str, body: Option<impl Serialize>, ) -> Result<T, ApifyError>

Send a request with exponential-backoff retries on 429 responses.

Starts with a 500 ms delay and doubles it up to 5 attempts. Use this for idempotent reads when you expect bursts of traffic.

Source§

impl HttpClient

Convenience helpers that unwrap Apify’s { "data": ... } envelope.

Source

pub async fn get_data<T: DeserializeOwned>( &self, path: &str, ) -> Result<T, ApifyError>

GET a single resource and return the inner data field.

Source

pub async fn post_data<T: DeserializeOwned, B: Serialize>( &self, path: &str, body: B, ) -> Result<T, ApifyError>

POST a JSON body and return the inner data field of the response.

Source

pub async fn put_data<T: DeserializeOwned, B: Serialize>( &self, path: &str, body: B, ) -> Result<T, ApifyError>

PUT a JSON body and return the inner data field of the response.

Source

pub async fn delete_request(&self, path: &str) -> Result<(), ApifyError>

DELETE a resource, returning () on success.

Source

pub async fn get_list<T: DeserializeOwned>( &self, path: &str, ) -> Result<ListData<T>, ApifyError>

GET a paginated list and return the inner ListData.

Trait Implementations§

Source§

impl Clone for HttpClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HttpClient

Source§

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

Formats the value using the given formatter. 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: Sized + 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: Sized + 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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