Enum Provider 

#[non_exhaustive]
pub enum Provider {
    Yahoo,
    Polygon,
    Fmp,
    AlphaVantage,
    CoinGecko,
    Fred,
    WorldBank,
    FiscalData,
    Bls,
    Frankfurter,
    Binance,
    Kraken,
    Finra,
    DefiLlama,
    Gdelt,
    Cftc,
    Nasdaq,
    Wikipedia,
    CongressTrades,
    Edgar,
    LocalMarketCalendar,
    LocalExchange,
    Custom(CustomId),
}

Typed identifier for a financial data provider.

Variants are feature-gated: unavailable providers are excluded at compile time.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Yahoo

Yahoo Finance (always available).

Polygon

Polygon.io (requires polygon feature).

Fmp

Financial Modeling Prep (requires fmp feature).

AlphaVantage

Alpha Vantage (requires alphavantage feature).

CoinGecko

CoinGecko cryptocurrency data (requires crypto feature).

Fred

FRED economic data (requires fred feature).

WorldBank

World Bank Open Data global macro indicators (requires worldbank feature, keyless).

FiscalData

US Treasury FiscalData (requires fiscaldata feature, keyless).

Bls

US Bureau of Labor Statistics (requires bls feature; keyless v1, keyed v2 when BLS_API_KEY is set).

Frankfurter

Frankfurter ECB reference exchange rates (requires frankfurter feature, keyless).

Binance

Binance public market data (requires binance feature, keyless).

Kraken

Kraken public market data (requires kraken feature, keyless).

Finra

FINRA daily short-sale volume (requires finra feature, keyless).

DefiLlama

DefiLlama DeFi TVL data (requires defi feature, keyless).

Gdelt

GDELT DOC 2.0 global news search (requires gdelt feature, keyless).

Cftc

CFTC Commitments of Traders futures positioning (requires cftc feature, keyless).

Nasdaq

Nasdaq market-wide earnings/IPO/dividend/split calendars (requires nasdaq feature, keyless).

Wikipedia

Wikipedia S&P 500 index-constituent table (requires wikipedia feature, keyless).

CongressTrades

Combined House + Senate PTR stock-trade disclosures (requires the housetrades and/or senatetrades feature, keyless).

Edgar

SEC EDGAR filings (always available, keyless).

LocalMarketCalendar

NYSE/NASDAQ market holidays, computed locally from federal-holiday rules rather than fetched (always available, no network call).

LocalExchange

A static table of major global exchanges (always available, no network call).

Custom(CustomId)

A provider supplied by a downstream crate and registered with ProvidersBuilder::with_adapter. Build one with Provider::custom, which is the only way to obtain a CustomId.

Interning is per-process, so a custom id deserializes only after something in this process has constructed it.

The id is held as an index rather than a string so that Provider stays small: it is stored in every model’s provider_id, and a fat pointer here grows Candle by 22%.

Implementations

impl Provider

pub fn from_id_str(s: &str) -> Option<Self>

Parse a provider id string back to the typed variant. Returns None if the string doesn’t match any known provider. Prefer this over string conversion to avoid panics.

pub fn custom(id: &'static str) -> Self

A provider this crate does not build, identified by id.

Interning is process-wide and append-only, so the same id always maps to the same value and Provider::custom("x") == Provider::custom("x").

pub fn as_str(self) -> &'static str

String identifier matching ProviderCore::id.

pub fn all() -> Vec<Self>

Every built-in provider variant compiled into this build, whether or not it is configured.

Custom providers are absent: they exist only once registered, and this answers from the enum rather than from a live [crate::ProviderSet]. Returns a Vec rather than an iterator because the variants are feature-gated and assembled at runtime.

pub fn capabilities(self) -> Capability

Capability bitflags for this provider variant, derived from each adapter’s as_* accessor overrides — implementing a capability trait and declaring it can no longer drift apart. Yahoo is the one exception: constructing YahooProvider needs a live auth handshake, so its set is a const declared beside its accessor overrides (yahoo::CAPS).

Provider::Custom returns Capability::NONE. An id carries no adapter, so a custom provider’s real set is ProviderAdapter::capabilities on the registered instance.

Trait Implementations

impl Clone for Provider

fn clone(&self) -> Provider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Provider

impl Debug for Provider

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

Formats the value using the given formatter.

impl Default for Provider

fn default() -> Provider

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Provider

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Provider

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

Formats the value using the given formatter.

impl Eq for Provider

impl Hash for Provider

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Provider

fn eq(&self, other: &Provider) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Provider

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Provider