Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Implementations

impl ClientBuilder

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

Sets the Alpaca API key.

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

Sets the Alpaca API secret key.

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

Overrides the default data API base URL.

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

Sets the request timeout for the internally constructed reqwest::Client.

Building fails if reqwest_client(...) is also used because the injected client owns its own timeout configuration.

pub fn reqwest_client(self, reqwest_client: Client) -> Self

Injects a preconfigured reqwest::Client for advanced transport tuning.

The injected client owns reqwest-level behavior such as connection pooling, proxy behavior, default headers, and timeout settings. Build validation rejects conflicting builder settings such as timeout(...).

pub fn observer(self, observer: Arc<dyn TransportObserver>) -> Self

Registers an immutable observer for successful transport responses.

Observers receive endpoint metadata only. They cannot change request execution or response shaping.

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

Sets the retry budget for the shared HTTP transport.

pub fn retry_on_429(self, retry_on_429: bool) -> Self

Enables or disables automatic retries on HTTP 429 responses.

pub fn respect_retry_after(self, respect_retry_after: bool) -> Self

Enables or disables honoring the Retry-After response header.

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

Sets the base retry backoff used by the shared HTTP transport.

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

Sets the maximum retry backoff used by the shared HTTP transport.

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

Sets an optional jitter window applied to retry waits.

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

Sets an optional total retry time budget for a request.

pub fn credentials_from_env(self) -> Result<Self, Error>

Loads credentials from APCA_API_KEY_ID and APCA_API_SECRET_KEY.

If both variables are unset, the builder is left unchanged. If only one side is set, this returns Error::InvalidConfiguration.

pub fn credentials_from_env_names( self, api_key_var: &str, secret_key_var: &str, ) -> Result<Self, Error>

Loads credentials from the provided environment variable names.

If both variables are unset, the builder is left unchanged. If only one side is set, this returns Error::InvalidConfiguration.

pub fn max_in_flight(self, max_in_flight: usize) -> Self

Sets the maximum number of concurrent in-flight requests.

pub fn build(self) -> Result<Client, Error>

Validates configuration and builds a Client.

Credentials must be provided as a pair or omitted as a pair.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.