finance-query 3.0.0

A Rust library for querying financial data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

//! Provider adapter traits — one trait per [`Capability`].
//!
//! A provider bridge implements [`ProviderCore`] plus the capability traits it
//! actually serves, then overrides the matching `as_*` accessors on
//! [`ProviderAdapter`] to return `Some(self)`. `ProviderAdapter::capabilities`
//! is *derived* from those accessors, so a provider's declared capability set
//! can never drift from what it implements.
//!
//! Within a capability trait, the primary operation is required (implementing
//! the trait without it is unrepresentable) while secondary operations default
//! to [`FinanceError::NotSupported`]; dispatch ([`super::ProviderSet::fetch`])
//! skips `NotSupported` and falls through to the next routed provider, so
//! ragged per-operation coverage degrades gracefully.

use super::{Operation, Provider};
use crate::error::FinanceError;

/// Identity shared by every capability trait: the provider id and the
/// `NotSupported` error constructor used by default method bodies.
pub trait ProviderCore: Send + Sync {
    /// This provider's identity, used for routing and health reporting.
    fn id(&self) -> Provider;

    /// The error a default method body returns for an unimplemented operation.
    fn not_supported(&self, operation: Operation) -> FinanceError {
        operation.not_supported(self.id())
    }
}

mod dispatch;
mod equity;
mod markets;

pub use dispatch::ProviderAdapter;
pub use equity::{
    ChartProvider, CorporateProvider, FilingsProvider, FundamentalsProvider, OptionsProvider,
    QuoteProvider,
};
pub use markets::CryptoProvider;
pub use markets::EconomicProvider;
pub use markets::ForexProvider;
pub use markets::{
    CalendarProvider, CommoditiesProvider, DiscoveryProvider, FuturesProvider, IndicesProvider,
    MarketProvider,
};