Skip to main content

ApifyClientBuilder

Struct ApifyClientBuilder 

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

Builder for ApifyClient.

§Example

use apify_client::ApifyClient;

let client = ApifyClient::builder()
    .token("my-api-token")
    .max_retries(5)
    .build();

Implementations§

Source§

impl ApifyClientBuilder

Source

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

Sets the API token used for authentication (sent as a Bearer token).

Source

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

Overrides the base URL of the API. The /v2 suffix is appended automatically.

Defaults to https://api.apify.com.

Source

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

Overrides the base URL used when building public, shareable resource URLs (e.g. a signed dataset-items URL). Defaults to the API base URL. The /v2 suffix is appended automatically.

Source

pub fn max_retries(self, max_retries: u32) -> Self

Sets the maximum number of retries for failed requests (default 8).

Source

pub fn min_delay_between_retries(self, delay: Duration) -> Self

Sets the minimum delay between retries (default 500ms).

Source

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

Sets the overall per-request timeout (default 360s).

Source

pub fn user_agent_suffix(self, suffix: impl Into<String>) -> Self

Appends a custom suffix to the User-Agent header.

Source

pub fn http_backend(self, backend: Arc<dyn HttpBackend>) -> Self

Replaces the default reqwest-based HTTP backend with a custom implementation.

This is the seam that makes the transport a replaceable component.

Source

pub fn build(self) -> ApifyClient

Builds the configured ApifyClient.

Trait Implementations§

Source§

impl Default for ApifyClientBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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