Struct ProvidersBuilder 

pub struct ProvidersBuilder { /* private fields */ }

Builder for Providers.

Implementations

impl ProvidersBuilder

pub fn fetch(self, mode: Fetch) -> Self

Configure how providers are queried. Default: Sequential.

Use Fetch::Sequential or Fetch::Parallel.

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

Set provider’s API key for the Providers this builds, instead of the process-global key from its init function.

Two Providers can hold different keys for the same provider, and a key can be replaced without restarting. Each distinct key gets its own rate-limit budget. Providers left unset fall back to the process-global key, then to the environment variable.

pub fn route( self, cap: Capability, providers: impl IntoIterator<Item = Provider>, ) -> Self

Route a capability to a specific provider priority list.

Providers referenced in the route are automatically added to the initialisation list if not already present. If omitted for a capability, Yahoo is used as default.

pub fn route_with( self, cap: Capability, providers: impl IntoIterator<Item = Provider>, fetch: Fetch, ) -> Self

Route a capability, overriding fetch for it alone.

Lets a quota-limited capability stay sequential while another races its providers.

pub fn region(self, region: Region) -> Self

Set the region (automatically sets lang and region code).

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

Set the language code (e.g., “en-US”, “ja-JP”).

Inherited by every Ticker/Tickers handle created from the built Providers. With the translation feature, a non-English language translates text fields on those handles automatically.

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

Set the region code (e.g., “US”, “JP”, “DE”).

For standard countries, prefer .region() instead to ensure correct lang/region pairing.

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

Set the HTTP request timeout.

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

Set the proxy URL.

pub fn retry(self, policy: RetryPolicy) -> Self

Opt into retrying FinanceError::RateLimited errors during dispatch See RetryPolicy for the exact semantics.

Default is no retry — omitting this call preserves the exact prior behavior: a RateLimited error is treated like any other failure and dispatch moves straight to the next routed provider.

pub fn with_adapter(self, adapter: Arc<dyn ProviderAdapter>) -> Self

Register an adapter this crate does not build itself.

Route to it by the id its ProviderCore::id returns, usually Provider::Custom. Registering alone does not route anything: a capability with no explicit route still falls back to its default provider.

let providers = Providers::builder()
    .with_adapter(my_adapter)
    .route(Capability::ECONOMIC, [Provider::custom("my-source")])
    .build()
    .await?;

pub async fn build(self) -> Result<Providers>

Build the Providers instance, initialising all configured providers.

Trait Implementations

impl Debug for ProvidersBuilder

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

Formats the value using the given formatter.

impl Default for ProvidersBuilder

fn default() -> Self

Returns the “default value” for a type.